Class CfnNatGateway

A CloudFormation AWS::EC2::NatGateway.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnNatGateway
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnNatGateway : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnNatGateway
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

Specifies a network address translation (NAT) gateway in the specified subnet. You can create either a public NAT gateway or a private NAT gateway. The default is a public NAT gateway. If you create a public NAT gateway, you must specify an elastic IP address.

With a NAT gateway, instances in a private subnet can connect to the internet, other AWS services, or an on-premises network using the IP address of the NAT gateway.

If you add a default route ( AWS::EC2::Route resource) that points to a NAT gateway, specify the NAT gateway ID for the route's NatGatewayId property.

For more information, see NAT Gateways in the Amazon VPC User Guide .

CloudformationResource: AWS::EC2::NatGateway

Link: 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;

CfnNatGateway cfnNatGateway = new CfnNatGateway(this, "MyCfnNatGateway", new CfnNatGatewayProps {
    SubnetId = "subnetId",

    // the properties below are optional
    AllocationId = "allocationId",
    ConnectivityType = "connectivityType",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnNatGateway(Construct, String, ICfnNatGatewayProps)

Create a new AWS::EC2::NatGateway.
CfnNatGateway(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnNatGateway(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AllocationId

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

The CloudFormation resource type name for this resource class.
CfnProperties
ConnectivityType

Indicates whether the NAT gateway supports public or private connectivity.
SubnetId

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

The tags for the NAT gateway.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnNatGateway(Construct, String, ICfnNatGatewayProps)

Create a new AWS::EC2::NatGateway.

public CfnNatGateway(Construct scope, string id, ICfnNatGatewayProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnNatGatewayProps
  • resource properties.

CfnNatGateway(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnNatGateway(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnNatGateway(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnNatGateway(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AllocationId

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

public virtual string AllocationId { get; set; }
Property Value

System.String

Remarks

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ConnectivityType

Indicates whether the NAT gateway supports public or private connectivity.

public virtual string ConnectivityType { get; set; }
Property Value

System.String

Remarks

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

SubnetId

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

public virtual string SubnetId { get; set; }
Property Value

System.String

Remarks

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

Tags

The tags for the NAT gateway.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct