@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
193 lines • 7.46 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway Site-to-Site VPN Routing Policies.
* A routing policy defines which routes are accepted from and advertised to the peer gateway via BGP.
*
* For more information, see [the main documentation](https://www.scaleway.com/en/docs/site-to-site-vpn/reference-content/understanding-s2svpn/).
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const policy = new scaleway.s2svpn.RoutingPolicy("policy", {
* name: "my-routing-policy",
* prefixFilterIns: ["10.0.2.0/24"],
* prefixFilterOuts: ["10.0.1.0/24"],
* });
* ```
*
* ### Multiple Prefixes
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const policy = new scaleway.s2svpn.RoutingPolicy("policy", {
* name: "my-routing-policy",
* prefixFilterIns: [
* "10.0.2.0/24",
* "10.0.3.0/24",
* ],
* prefixFilterOuts: [
* "10.0.1.0/24",
* "172.16.0.0/16",
* ],
* });
* ```
*
* ## Import
*
* Routing Policies can be imported using `{region}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:s2svpn/routingPolicy:RoutingPolicy main fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class RoutingPolicy extends pulumi.CustomResource {
/**
* Get an existing RoutingPolicy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RoutingPolicyState, opts?: pulumi.CustomResourceOptions): RoutingPolicy;
/**
* Returns true if the given object is an instance of RoutingPolicy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RoutingPolicy;
/**
* The date and time of the creation of the routing policy (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* Defines whether the routing policy is for IPv6 prefixes. Defaults to `false` (IPv4).
*/
readonly isIpv6: pulumi.Output<boolean>;
/**
* The name of the routing policy. If not provided, it will be randomly generated.
*/
readonly name: pulumi.Output<string>;
/**
* The Organization ID the routing policy is associated with.
*/
readonly organizationId: pulumi.Output<string>;
/**
* List of IP prefixes (in CIDR notation) to accept from the peer gateway. These are the routes that the customer gateway can announce to Scaleway.
*/
readonly prefixFilterIns: pulumi.Output<string[] | undefined>;
/**
* List of IP prefixes (in CIDR notation) to advertise to the peer gateway. These are the routes that Scaleway will announce to the customer gateway.
*/
readonly prefixFilterOuts: pulumi.Output<string[] | undefined>;
/**
* `projectId`) The ID of the project the routing policy is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* `region`) The region in which the routing policy should be created.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* The list of tags to apply to the routing policy.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The date and time of the last update of the routing policy (RFC 3339 format).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a RoutingPolicy resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: RoutingPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RoutingPolicy resources.
*/
export interface RoutingPolicyState {
/**
* The date and time of the creation of the routing policy (RFC 3339 format).
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* Defines whether the routing policy is for IPv6 prefixes. Defaults to `false` (IPv4).
*/
isIpv6?: pulumi.Input<boolean | undefined>;
/**
* The name of the routing policy. If not provided, it will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The Organization ID the routing policy is associated with.
*/
organizationId?: pulumi.Input<string | undefined>;
/**
* List of IP prefixes (in CIDR notation) to accept from the peer gateway. These are the routes that the customer gateway can announce to Scaleway.
*/
prefixFilterIns?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* List of IP prefixes (in CIDR notation) to advertise to the peer gateway. These are the routes that Scaleway will announce to the customer gateway.
*/
prefixFilterOuts?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* `projectId`) The ID of the project the routing policy is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the routing policy should be created.
*/
region?: pulumi.Input<string | undefined>;
/**
* The list of tags to apply to the routing policy.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The date and time of the last update of the routing policy (RFC 3339 format).
*/
updatedAt?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a RoutingPolicy resource.
*/
export interface RoutingPolicyArgs {
/**
* Defines whether the routing policy is for IPv6 prefixes. Defaults to `false` (IPv4).
*/
isIpv6?: pulumi.Input<boolean | undefined>;
/**
* The name of the routing policy. If not provided, it will be randomly generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* List of IP prefixes (in CIDR notation) to accept from the peer gateway. These are the routes that the customer gateway can announce to Scaleway.
*/
prefixFilterIns?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* List of IP prefixes (in CIDR notation) to advertise to the peer gateway. These are the routes that Scaleway will announce to the customer gateway.
*/
prefixFilterOuts?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* `projectId`) The ID of the project the routing policy is associated with.
*/
projectId?: pulumi.Input<string | undefined>;
/**
* `region`) The region in which the routing policy should be created.
*/
region?: pulumi.Input<string | undefined>;
/**
* The list of tags to apply to the routing policy.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=routingPolicy.d.ts.map