Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpc
  5. NatGateway
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.vpc.NatGateway

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-alicloud

    Import

    Nat gateway can be imported using the id, e.g.

    $ pulumi import alicloud:vpc/natGateway:NatGateway example <id>

    Create NatGateway Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NatGateway(name: string, args: NatGatewayArgs, opts?: CustomResourceOptions);
    @overload
def NatGateway(resource_name: str,
               args: NatGatewayArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def NatGateway(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               vpc_id: Optional[str] = None,
               nat_gateway_name: Optional[str] = None,
               name: Optional[str] = None,
               eip_bind_mode: Optional[str] = None,
               force: Optional[bool] = None,
               nat_type: Optional[str] = None,
               internet_charge_type: Optional[str] = None,
               dry_run: Optional[bool] = None,
               deletion_protection: Optional[bool] = None,
               instance_charge_type: Optional[str] = None,
               network_type: Optional[str] = None,
               payment_type: Optional[str] = None,
               period: Optional[int] = None,
               specification: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               description: Optional[str] = None,
               vswitch_id: Optional[str] = None)
    func NewNatGateway(ctx *Context, name string, args NatGatewayArgs, opts ...ResourceOption) (*NatGateway, error)
    public NatGateway(string name, NatGatewayArgs args, CustomResourceOptions? opts = null)
    public NatGateway(String name, NatGatewayArgs args)
public NatGateway(String name, NatGatewayArgs args, CustomResourceOptions options)

    type: alicloud:vpc:NatGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NatGatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var alicloudNatGatewayResource = new AliCloud.Vpc.NatGateway("alicloudNatGatewayResource", new()
{
    VpcId = "string",
    NatGatewayName = "string",
    Name = "string",
    EipBindMode = "string",
    Force = false,
    NatType = "string",
    InternetChargeType = "string",
    DryRun = false,
    DeletionProtection = false,
    InstanceChargeType = "string",
    NetworkType = "string",
    PaymentType = "string",
    Period = 0,
    Specification = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Description = "string",
    VswitchId = "string",
});

    example, err := vpc.NewNatGateway(ctx, "alicloudNatGatewayResource", &vpc.NatGatewayArgs{
	VpcId:              pulumi.String("string"),
	NatGatewayName:     pulumi.String("string"),
	Name:               pulumi.String("string"),
	EipBindMode:        pulumi.String("string"),
	Force:              pulumi.Bool(false),
	NatType:            pulumi.String("string"),
	InternetChargeType: pulumi.String("string"),
	DryRun:             pulumi.Bool(false),
	DeletionProtection: pulumi.Bool(false),
	InstanceChargeType: pulumi.String("string"),
	NetworkType:        pulumi.String("string"),
	PaymentType:        pulumi.String("string"),
	Period:             pulumi.Int(0),
	Specification:      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	VswitchId:   pulumi.String("string"),
})

    var alicloudNatGatewayResource = new NatGateway("alicloudNatGatewayResource", NatGatewayArgs.builder()
    .vpcId("string")
    .natGatewayName("string")
    .name("string")
    .eipBindMode("string")
    .force(false)
    .natType("string")
    .internetChargeType("string")
    .dryRun(false)
    .deletionProtection(false)
    .instanceChargeType("string")
    .networkType("string")
    .paymentType("string")
    .period(0)
    .specification("string")
    .tags(Map.of("string", "string"))
    .description("string")
    .vswitchId("string")
    .build());

    alicloud_nat_gateway_resource = alicloud.vpc.NatGateway("alicloudNatGatewayResource",
    vpc_id="string",
    nat_gateway_name="string",
    name="string",
    eip_bind_mode="string",
    force=False,
    nat_type="string",
    internet_charge_type="string",
    dry_run=False,
    deletion_protection=False,
    instance_charge_type="string",
    network_type="string",
    payment_type="string",
    period=0,
    specification="string",
    tags={
        "string": "string",
    },
    description="string",
    vswitch_id="string")

    const alicloudNatGatewayResource = new alicloud.vpc.NatGateway("alicloudNatGatewayResource", {
    vpcId: "string",
    natGatewayName: "string",
    name: "string",
    eipBindMode: "string",
    force: false,
    natType: "string",
    internetChargeType: "string",
    dryRun: false,
    deletionProtection: false,
    instanceChargeType: "string",
    networkType: "string",
    paymentType: "string",
    period: 0,
    specification: "string",
    tags: {
        string: "string",
    },
    description: "string",
    vswitchId: "string",
});

    type: alicloud:vpc:NatGateway
properties:
    deletionProtection: false
    description: string
    dryRun: false
    eipBindMode: string
    force: false
    instanceChargeType: string
    internetChargeType: string
    name: string
    natGatewayName: string
    natType: string
    networkType: string
    paymentType: string
    period: 0
    specification: string
    tags:
        string: string
    vpcId: string
    vswitchId: string

    NatGateway Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NatGateway resource accepts the following input properties:

    VpcId string
    The VPC ID.
    DeletionProtection bool
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    Description string
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    DryRun bool
    Specifies whether to only precheck this request. Default value: false.
    EipBindMode string
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    Force bool
    Specifies whether to forcefully delete the NAT gateway.
    InstanceChargeType string
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    InternetChargeType string
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    Name string
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    NatGatewayName string
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    NatType string
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    NetworkType string
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    PaymentType string
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    Period int

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    Specification string
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    Tags Dictionary<string, string>
    The tags of NAT gateway.
    VswitchId string
    The id of VSwitch.
    VpcId string
    The VPC ID.
    DeletionProtection bool
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    Description string
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    DryRun bool
    Specifies whether to only precheck this request. Default value: false.
    EipBindMode string
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    Force bool
    Specifies whether to forcefully delete the NAT gateway.
    InstanceChargeType string
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    InternetChargeType string
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    Name string
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    NatGatewayName string
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    NatType string
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    NetworkType string
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    PaymentType string
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    Period int

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    Specification string
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    Tags map[string]string
    The tags of NAT gateway.
    VswitchId string
    The id of VSwitch.
    vpcId String
    The VPC ID.
    deletionProtection Boolean
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    description String
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    dryRun Boolean
    Specifies whether to only precheck this request. Default value: false.
    eipBindMode String
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    force Boolean
    Specifies whether to forcefully delete the NAT gateway.
    instanceChargeType String
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    internetChargeType String
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    name String
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    natGatewayName String
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    natType String
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    networkType String
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    paymentType String
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    period Integer

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    specification String
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    tags Map<String,String>
    The tags of NAT gateway.
    vswitchId String
    The id of VSwitch.
    vpcId string
    The VPC ID.
    deletionProtection boolean
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    description string
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    dryRun boolean
    Specifies whether to only precheck this request. Default value: false.
    eipBindMode string
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    force boolean
    Specifies whether to forcefully delete the NAT gateway.
    instanceChargeType string
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    internetChargeType string
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    name string
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    natGatewayName string
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    natType string
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    networkType string
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    paymentType string
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    period number

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    specification string
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    tags {[key: string]: string}
    The tags of NAT gateway.
    vswitchId string
    The id of VSwitch.
    vpc_id str
    The VPC ID.
    deletion_protection bool
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    description str
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    dry_run bool
    Specifies whether to only precheck this request. Default value: false.
    eip_bind_mode str
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    force bool
    Specifies whether to forcefully delete the NAT gateway.
    instance_charge_type str
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    internet_charge_type str
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    name str
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    nat_gateway_name str
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    nat_type str
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    network_type str
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    payment_type str
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    period int

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    specification str
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    tags Mapping[str, str]
    The tags of NAT gateway.
    vswitch_id str
    The id of VSwitch.
    vpcId String
    The VPC ID.
    deletionProtection Boolean
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    description String
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    dryRun Boolean
    Specifies whether to only precheck this request. Default value: false.
    eipBindMode String
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    force Boolean
    Specifies whether to forcefully delete the NAT gateway.
    instanceChargeType String
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    internetChargeType String
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    name String
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    natGatewayName String
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    natType String
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    networkType String
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    paymentType String
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    period Number

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    specification String
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    tags Map<String>
    The tags of NAT gateway.
    vswitchId String
    The id of VSwitch.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NatGateway resource produces the following output properties:

    ForwardTableIds string
    The nat gateway will auto create a forward item.
    Id string
    The provider-assigned unique ID for this managed resource.
    SnatTableIds string
    The nat gateway will auto create a snat item.
    Status string
    (Available since v1.121.0) The status of NAT gateway.
    ForwardTableIds string
    The nat gateway will auto create a forward item.
    Id string
    The provider-assigned unique ID for this managed resource.
    SnatTableIds string
    The nat gateway will auto create a snat item.
    Status string
    (Available since v1.121.0) The status of NAT gateway.
    forwardTableIds String
    The nat gateway will auto create a forward item.
    id String
    The provider-assigned unique ID for this managed resource.
    snatTableIds String
    The nat gateway will auto create a snat item.
    status String
    (Available since v1.121.0) The status of NAT gateway.
    forwardTableIds string
    The nat gateway will auto create a forward item.
    id string
    The provider-assigned unique ID for this managed resource.
    snatTableIds string
    The nat gateway will auto create a snat item.
    status string
    (Available since v1.121.0) The status of NAT gateway.
    forward_table_ids str
    The nat gateway will auto create a forward item.
    id str
    The provider-assigned unique ID for this managed resource.
    snat_table_ids str
    The nat gateway will auto create a snat item.
    status str
    (Available since v1.121.0) The status of NAT gateway.
    forwardTableIds String
    The nat gateway will auto create a forward item.
    id String
    The provider-assigned unique ID for this managed resource.
    snatTableIds String
    The nat gateway will auto create a snat item.
    status String
    (Available since v1.121.0) The status of NAT gateway.

    Look up Existing NatGateway Resource

    Get an existing NatGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NatGatewayState, opts?: CustomResourceOptions): NatGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        deletion_protection: Optional[bool] = None,
        description: Optional[str] = None,
        dry_run: Optional[bool] = None,
        eip_bind_mode: Optional[str] = None,
        force: Optional[bool] = None,
        forward_table_ids: Optional[str] = None,
        instance_charge_type: Optional[str] = None,
        internet_charge_type: Optional[str] = None,
        name: Optional[str] = None,
        nat_gateway_name: Optional[str] = None,
        nat_type: Optional[str] = None,
        network_type: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[int] = None,
        snat_table_ids: Optional[str] = None,
        specification: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None) -> NatGateway
    func GetNatGateway(ctx *Context, name string, id IDInput, state *NatGatewayState, opts ...ResourceOption) (*NatGateway, error)
    public static NatGateway Get(string name, Input<string> id, NatGatewayState? state, CustomResourceOptions? opts = null)
    public static NatGateway get(String name, Output<String> id, NatGatewayState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DeletionProtection bool
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    Description string
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    DryRun bool
    Specifies whether to only precheck this request. Default value: false.
    EipBindMode string
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    Force bool
    Specifies whether to forcefully delete the NAT gateway.
    ForwardTableIds string
    The nat gateway will auto create a forward item.
    InstanceChargeType string
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    InternetChargeType string
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    Name string
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    NatGatewayName string
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    NatType string
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    NetworkType string
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    PaymentType string
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    Period int

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    SnatTableIds string
    The nat gateway will auto create a snat item.
    Specification string
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    Status string
    (Available since v1.121.0) The status of NAT gateway.
    Tags Dictionary<string, string>
    The tags of NAT gateway.
    VpcId string
    The VPC ID.
    VswitchId string
    The id of VSwitch.
    DeletionProtection bool
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    Description string
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    DryRun bool
    Specifies whether to only precheck this request. Default value: false.
    EipBindMode string
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    Force bool
    Specifies whether to forcefully delete the NAT gateway.
    ForwardTableIds string
    The nat gateway will auto create a forward item.
    InstanceChargeType string
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    InternetChargeType string
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    Name string
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    NatGatewayName string
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    NatType string
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    NetworkType string
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    PaymentType string
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    Period int

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    SnatTableIds string
    The nat gateway will auto create a snat item.
    Specification string
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    Status string
    (Available since v1.121.0) The status of NAT gateway.
    Tags map[string]string
    The tags of NAT gateway.
    VpcId string
    The VPC ID.
    VswitchId string
    The id of VSwitch.
    deletionProtection Boolean
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    description String
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    dryRun Boolean
    Specifies whether to only precheck this request. Default value: false.
    eipBindMode String
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    force Boolean
    Specifies whether to forcefully delete the NAT gateway.
    forwardTableIds String
    The nat gateway will auto create a forward item.
    instanceChargeType String
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    internetChargeType String
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    name String
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    natGatewayName String
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    natType String
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    networkType String
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    paymentType String
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    period Integer

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    snatTableIds String
    The nat gateway will auto create a snat item.
    specification String
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    status String
    (Available since v1.121.0) The status of NAT gateway.
    tags Map<String,String>
    The tags of NAT gateway.
    vpcId String
    The VPC ID.
    vswitchId String
    The id of VSwitch.
    deletionProtection boolean
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    description string
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    dryRun boolean
    Specifies whether to only precheck this request. Default value: false.
    eipBindMode string
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    force boolean
    Specifies whether to forcefully delete the NAT gateway.
    forwardTableIds string
    The nat gateway will auto create a forward item.
    instanceChargeType string
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    internetChargeType string
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    name string
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    natGatewayName string
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    natType string
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    networkType string
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    paymentType string
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    period number

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    snatTableIds string
    The nat gateway will auto create a snat item.
    specification string
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    status string
    (Available since v1.121.0) The status of NAT gateway.
    tags {[key: string]: string}
    The tags of NAT gateway.
    vpcId string
    The VPC ID.
    vswitchId string
    The id of VSwitch.
    deletion_protection bool
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    description str
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    dry_run bool
    Specifies whether to only precheck this request. Default value: false.
    eip_bind_mode str
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    force bool
    Specifies whether to forcefully delete the NAT gateway.
    forward_table_ids str
    The nat gateway will auto create a forward item.
    instance_charge_type str
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    internet_charge_type str
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    name str
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    nat_gateway_name str
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    nat_type str
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    network_type str
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    payment_type str
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    period int

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    snat_table_ids str
    The nat gateway will auto create a snat item.
    specification str
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    status str
    (Available since v1.121.0) The status of NAT gateway.
    tags Mapping[str, str]
    The tags of NAT gateway.
    vpc_id str
    The VPC ID.
    vswitch_id str
    The id of VSwitch.
    deletionProtection Boolean
    Whether enable the deletion protection or not. Default value: false.

    • true: Enable deletion protection.
    • false: Disable deletion protection.
    description String
    Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.
    dryRun Boolean
    Specifies whether to only precheck this request. Default value: false.
    eipBindMode String
    The EIP binding mode of the NAT gateway. Default value: MULTI_BINDED. Valid values:

    • MULTI_BINDED: Multi EIP network card visible mode.
    • NAT: EIP normal mode, compatible with IPv4 gateway.
    force Boolean
    Specifies whether to forcefully delete the NAT gateway.
    forwardTableIds String
    The nat gateway will auto create a forward item.
    instanceChargeType String
    Field instance_charge_type has been deprecated from provider version 1.121.0. New field payment_type instead.
    internetChargeType String
    The internet charge type. Valid values PayByLcu and PayBySpec. The PayByLcu is only support enhanced NAT. NOTE: From 1.137.0+, The PayBySpec has been deprecated.
    name String
    Field name has been deprecated from provider version 1.121.0. New field nat_gateway_name instead.
    natGatewayName String
    Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.
    natType String
    The type of NAT gateway. Valid values: Normal and Enhanced. NOTE: From 1.137.0+, The Normal has been deprecated.
    networkType String
    Indicates the type of the created NAT gateway. Valid values internet and intranet. internet: Internet NAT Gateway. intranet: VPC NAT Gateway.
    paymentType String
    The billing method of the NAT gateway. Valid values are PayAsYouGo and Subscription. Default to PayAsYouGo.
    period Number

    The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console. NOTE: International station only supports Subscription.

    NOTE: The attribute period is only used to create Subscription instance or modify the PayAsYouGo instance to Subscription. Once effect, it will not be modified that means running pulumi up will not effect the resource.

    snatTableIds String
    The nat gateway will auto create a snat item.
    specification String
    The specification of the nat gateway. Valid values are Small, Middle and Large. Effective when internet_charge_type is PayBySpec and network_type is internet. Details refer to Nat Gateway Specification.
    status String
    (Available since v1.121.0) The status of NAT gateway.
    tags Map<String>
    The tags of NAT gateway.
    vpcId String
    The VPC ID.
    vswitchId String
    The id of VSwitch.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-alicloud