aws-native.ec2.NatGateway

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. For more information, see NAT gateways in the Amazon VPC User Guide. 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. When you associate an Elastic IP address or secondary Elastic IP address with a public NAT gateway, the network border group of the Elastic IP address must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. Otherwise, the NAT gateway fails to launch. You can see the network border group for the AZ by viewing the details of the subnet. Similarly, you can view the network border group for the Elastic IP address by viewing its details. For more information, see Allocate an Elastic IP address in the Amazon VPC User Guide.

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,
               subnet_id: Optional[str] = None,
               allocation_id: Optional[str] = None,
               connectivity_type: Optional[str] = None,
               max_drain_duration_seconds: Optional[int] = None,
               private_ip_address: Optional[str] = None,
               secondary_allocation_ids: Optional[Sequence[str]] = None,
               secondary_private_ip_address_count: Optional[int] = None,
               secondary_private_ip_addresses: Optional[Sequence[str]] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = 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: aws-native:ec2:NatGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

The NatGateway resource accepts the following input properties:

Outputs

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

Supporting Types

Tag, TagArgs

Package Details

Repository

AWS Native pulumi/pulumi-aws-native

License

Apache-2.0