@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
149 lines • 4.82 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Gets information about an Interlink Routing Policy.
*
* A routing policy defines IP prefix filters that control which routes are accepted from and advertised to a peer via BGP on an Interlink connection.
*
* For more information, see [the Interlink documentation](https://www.scaleway.com/en/docs/network/interlink/) and [API documentation](https://www.scaleway.com/en/developers/api/interlink/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get routing policy info by ID
* const myPolicy = scaleway.interlink.getRoutingPolicy({
* routingPolicyId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get routing policy info by name
* const myPolicy = scaleway.interlink.getRoutingPolicy({
* name: "my-routing-policy",
* });
* ```
*/
export declare function getRoutingPolicy(args?: GetRoutingPolicyArgs, opts?: pulumi.InvokeOptions): Promise<GetRoutingPolicyResult>;
/**
* A collection of arguments for invoking getRoutingPolicy.
*/
export interface GetRoutingPolicyArgs {
/**
* The name of the routing policy. Conflicts with `routingPolicyId`.
*/
name?: string;
/**
* The ID of the project the routing policy is associated with.
*/
projectId?: string;
/**
* `region`) The region in which the routing policy exists.
*/
region?: string;
/**
* The ID of the routing policy. Conflicts with `name`.
*
* > **Note** You must specify at least one: `name` and/or `routingPolicyId`.
*/
routingPolicyId?: string;
}
/**
* A collection of values returned by getRoutingPolicy.
*/
export interface GetRoutingPolicyResult {
/**
* The date and time of creation of the routing policy.
*/
readonly createdAt: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Whether the routing policy uses IPv6 prefixes.
*/
readonly isIpv6: boolean;
readonly name?: string;
/**
* The Organization ID the routing policy is associated with.
*/
readonly organizationId: string;
/**
* List of IP prefixes accepted from the peer.
*/
readonly prefixFilterIns: string[];
/**
* List of IP prefixes advertised to the peer.
*/
readonly prefixFilterOuts: string[];
readonly projectId?: string;
readonly region?: string;
readonly routingPolicyId?: string;
/**
* The tags associated with the routing policy.
*/
readonly tags: string[];
/**
* The date and time of the last update of the routing policy.
*/
readonly updatedAt: string;
}
/**
* Gets information about an Interlink Routing Policy.
*
* A routing policy defines IP prefix filters that control which routes are accepted from and advertised to a peer via BGP on an Interlink connection.
*
* For more information, see [the Interlink documentation](https://www.scaleway.com/en/docs/network/interlink/) and [API documentation](https://www.scaleway.com/en/developers/api/interlink/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get routing policy info by ID
* const myPolicy = scaleway.interlink.getRoutingPolicy({
* routingPolicyId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* // Get routing policy info by name
* const myPolicy = scaleway.interlink.getRoutingPolicy({
* name: "my-routing-policy",
* });
* ```
*/
export declare function getRoutingPolicyOutput(args?: GetRoutingPolicyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRoutingPolicyResult>;
/**
* A collection of arguments for invoking getRoutingPolicy.
*/
export interface GetRoutingPolicyOutputArgs {
/**
* The name of the routing policy. Conflicts with `routingPolicyId`.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project the routing policy is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the routing policy exists.
*/
region?: pulumi.Input<string | undefined>;
/**
* The ID of the routing policy. Conflicts with `name`.
*
* > **Note** You must specify at least one: `name` and/or `routingPolicyId`.
*/
routingPolicyId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getRoutingPolicy.d.ts.map