@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
224 lines • 7.67 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway VPC Ingress Rules.
*
* An ingress routing rule routes incoming traffic from a peered VPC to a specific private IP address within a destination VPC's Private Network.
*
* For more information, see [the main documentation](https://www.scaleway.com/en/docs/vpc/concepts/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my-vpc"});
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "my-private-network",
* vpcId: vpc01.id,
* });
* const main = new scaleway.network.IngressRule("main", {
* vpcId: vpc01.id,
* source: "10.0.0.0/24",
* nexthopPrivateNetworkId: pn01.id,
* nexthopResourceIp: "10.0.0.10",
* description: "Allow ingress traffic from 10.0.0.0/24",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {
* name: "my-vpc",
* region: "nl-ams",
* });
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "my-private-network",
* vpcId: vpc01.id,
* region: "nl-ams",
* });
* const main = new scaleway.network.IngressRule("main", {
* vpcId: vpc01.id,
* source: "10.0.0.0/24",
* nexthopPrivateNetworkId: pn01.id,
* nexthopResourceIp: "10.0.0.10",
* region: "nl-ams",
* });
* ```
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const vpc01 = new scaleway.network.Vpc("vpc01", {name: "my-vpc"});
* const pn01 = new scaleway.network.PrivateNetwork("pn01", {
* name: "my-private-network",
* vpcId: vpc01.id,
* });
* const main = new scaleway.network.IngressRule("main", {
* vpcId: vpc01.id,
* source: "10.0.0.0/24",
* nexthopPrivateNetworkId: pn01.id,
* nexthopResourceIp: "10.0.0.10",
* description: "Allow ingress traffic from 10.0.0.0/24",
* tags: [
* "production",
* "ingress",
* ],
* });
* ```
*
* ## Import
*
* VPC ingress rules can be imported using `{region}/{id}`, e.g.
*
* ```sh
* $ pulumi import scaleway:network/ingressRule:IngressRule main fr-par/11111111-1111-1111-1111-111111111111
* ```
*/
export declare class IngressRule extends pulumi.CustomResource {
/**
* Get an existing IngressRule 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?: IngressRuleState, opts?: pulumi.CustomResourceOptions): IngressRule;
/**
* Returns true if the given object is an instance of IngressRule. 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 IngressRule;
/**
* The date and time of the creation of the ingress rule (RFC 3339 format).
*/
readonly createdAt: pulumi.Output<string>;
/**
* The description of the ingress rule.
*/
readonly description: pulumi.Output<string>;
/**
* Whether the ingress rule is for IPv6 traffic (derived from `source`).
*/
readonly isIpv6: pulumi.Output<boolean>;
/**
* The ID of the private network used as nexthop for traffic matched by this rule.
*/
readonly nexthopPrivateNetworkId: pulumi.Output<string>;
/**
* IP of the nexthop resource that should handle traffic matched by this rule.
*/
readonly nexthopResourceIp: pulumi.Output<string>;
/**
* `region`) The region of the ingress rule.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* Source IP range (in CIDR notation) to which the ingress rule applies.
*/
readonly source: pulumi.Output<string>;
/**
* The tags to associate with the ingress rule.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* The date and time of the last update of the ingress rule (RFC 3339 format).
*/
readonly updatedAt: pulumi.Output<string>;
/**
* The ID of the VPC in which to create the ingress rule.
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a IngressRule 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: IngressRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IngressRule resources.
*/
export interface IngressRuleState {
/**
* The date and time of the creation of the ingress rule (RFC 3339 format).
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* The description of the ingress rule.
*/
description?: pulumi.Input<string | undefined>;
/**
* Whether the ingress rule is for IPv6 traffic (derived from `source`).
*/
isIpv6?: pulumi.Input<boolean | undefined>;
/**
* The ID of the private network used as nexthop for traffic matched by this rule.
*/
nexthopPrivateNetworkId?: pulumi.Input<string | undefined>;
/**
* IP of the nexthop resource that should handle traffic matched by this rule.
*/
nexthopResourceIp?: pulumi.Input<string | undefined>;
/**
* `region`) The region of the ingress rule.
*/
region?: pulumi.Input<string | undefined>;
/**
* Source IP range (in CIDR notation) to which the ingress rule applies.
*/
source?: pulumi.Input<string | undefined>;
/**
* The tags to associate with the ingress rule.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The date and time of the last update of the ingress rule (RFC 3339 format).
*/
updatedAt?: pulumi.Input<string | undefined>;
/**
* The ID of the VPC in which to create the ingress rule.
*/
vpcId?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a IngressRule resource.
*/
export interface IngressRuleArgs {
/**
* The description of the ingress rule.
*/
description?: pulumi.Input<string | undefined>;
/**
* The ID of the private network used as nexthop for traffic matched by this rule.
*/
nexthopPrivateNetworkId: pulumi.Input<string>;
/**
* IP of the nexthop resource that should handle traffic matched by this rule.
*/
nexthopResourceIp: pulumi.Input<string>;
/**
* `region`) The region of the ingress rule.
*/
region?: pulumi.Input<string | undefined>;
/**
* Source IP range (in CIDR notation) to which the ingress rule applies.
*/
source: pulumi.Input<string>;
/**
* The tags to associate with the ingress rule.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The ID of the VPC in which to create the ingress rule.
*/
vpcId: pulumi.Input<string>;
}
//# sourceMappingURL=ingressRule.d.ts.map