Class CfnNatGatewayProps

Properties for defining a CfnNatGateway.

Inheritance

object

CfnNatGatewayProps

Implements

ICfnNatGatewayProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnNatGatewayProps : ICfnNatGatewayProps

Syntax (vb)

Public Class CfnNatGatewayProps Implements ICfnNatGatewayProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnNatGatewayProps = new CfnNatGatewayProps {
                 SubnetId = "subnetId",

                 // the properties below are optional
                 AllocationId = "allocationId",
                 ConnectivityType = "connectivityType",
                 MaxDrainDurationSeconds = 123,
                 PrivateIpAddress = "privateIpAddress",
                 SecondaryAllocationIds = new [] { "secondaryAllocationIds" },
                 SecondaryPrivateIpAddressCount = 123,
                 SecondaryPrivateIpAddresses = new [] { "secondaryPrivateIpAddresses" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnNatGatewayProps()

Properties for defining a CfnNatGateway.

Properties

AllocationId	[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
ConnectivityType	Indicates whether the NAT gateway supports public or private connectivity.
MaxDrainDurationSeconds	The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.
PrivateIpAddress	The private IPv4 address to assign to the NAT gateway.
SecondaryAllocationIds	Secondary EIP allocation IDs.
SecondaryPrivateIpAddressCount	[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
SecondaryPrivateIpAddresses	Secondary private IPv4 addresses.
SubnetId	The ID of the subnet in which the NAT gateway is located.
Tags	The tags for the NAT gateway.

Constructors

CfnNatGatewayProps()

Properties for defining a CfnNatGateway.

public CfnNatGatewayProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EC2;

             var cfnNatGatewayProps = new CfnNatGatewayProps {
                 SubnetId = "subnetId",

                 // the properties below are optional
                 AllocationId = "allocationId",
                 ConnectivityType = "connectivityType",
                 MaxDrainDurationSeconds = 123,
                 PrivateIpAddress = "privateIpAddress",
                 SecondaryAllocationIds = new [] { "secondaryAllocationIds" },
                 SecondaryPrivateIpAddressCount = 123,
                 SecondaryPrivateIpAddresses = new [] { "secondaryPrivateIpAddresses" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AllocationId

[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.

public string? AllocationId { get; set; }

Property Value

string

Remarks

This property is required for a public NAT gateway and cannot be specified with a private NAT gateway.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-allocationid

ConnectivityType

Indicates whether the NAT gateway supports public or private connectivity.

public string? ConnectivityType { get; set; }

Property Value

string

Remarks

The default is public connectivity.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-connectivitytype

MaxDrainDurationSeconds

The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.

public double? MaxDrainDurationSeconds { get; set; }

Property Value

double?

Remarks

Default value is 350 seconds.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-maxdraindurationseconds

PrivateIpAddress

The private IPv4 address to assign to the NAT gateway.

public string? PrivateIpAddress { get; set; }

Property Value

string

Remarks

If you don't provide an address, a private IPv4 address will be automatically assigned.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-privateipaddress

SecondaryAllocationIds

Secondary EIP allocation IDs.

public string[]? SecondaryAllocationIds { get; set; }

Property Value

string[]

Remarks

For more information, see Create a NAT gateway in the Amazon VPC User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryallocationids

SecondaryPrivateIpAddressCount

[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.

public double? SecondaryPrivateIpAddressCount { get; set; }

Property Value

double?

Remarks

For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide .

SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresscount

SecondaryPrivateIpAddresses

Secondary private IPv4 addresses.

public string[]? SecondaryPrivateIpAddresses { get; set; }

Property Value

string[]

Remarks

For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud User Guide .

SecondaryPrivateIpAddressCount and SecondaryPrivateIpAddresses cannot be set at the same time.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-natgateway.html#cfn-ec2-natgateway-secondaryprivateipaddresses

SubnetId

The ID of the subnet in which the NAT gateway is located.

public string SubnetId { get; set; }