software.amazon.awscdk.services.ec2

Interface CfnNatGatewayProps

All Known Implementing Classes:

CfnNatGatewayProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:28.169Z")
public interface CfnNatGatewayProps

Properties for defining a `CfnNatGateway`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnNatGatewayProps cfnNatGatewayProps = CfnNatGatewayProps.builder()
         .subnetId("subnetId")
         // the properties below are optional
         .allocationId("allocationId")
         .connectivityType("connectivityType")
         .maxDrainDurationSeconds(123)
         .privateIpAddress("privateIpAddress")
         .secondaryAllocationIds(List.of("secondaryAllocationIds"))
         .secondaryPrivateIpAddressCount(123)
         .secondaryPrivateIpAddresses(List.of("secondaryPrivateIpAddresses"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnNatGatewayProps.Builder A builder for CfnNatGatewayProps
static class	CfnNatGatewayProps.Jsii$Proxy An implementation for CfnNatGatewayProps

Method Summary

Modifier and Type	Method and Description
static CfnNatGatewayProps.Builder	builder()
default java.lang.String	getAllocationId() [Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
default java.lang.String	getConnectivityType() Indicates whether the NAT gateway supports public or private connectivity.
default java.lang.Number	getMaxDrainDurationSeconds() The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress.
default java.lang.String	getPrivateIpAddress() The private IPv4 address to assign to the NAT gateway.
default java.util.List<java.lang.String>	getSecondaryAllocationIds() Secondary EIP allocation IDs.
default java.lang.Number	getSecondaryPrivateIpAddressCount() [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
default java.util.List<java.lang.String>	getSecondaryPrivateIpAddresses() Secondary private IPv4 addresses.
java.lang.String	getSubnetId() The ID of the subnet in which the NAT gateway is located.
default java.util.List<CfnTag>	getTags() The tags for the NAT gateway.

Method Detail

getSubnetId

java.lang.String getSubnetId()

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

getAllocationId

default java.lang.String getAllocationId()

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

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

getConnectivityType

default java.lang.String getConnectivityType()

Indicates whether the NAT gateway supports public or private connectivity.

The default is public connectivity.

getMaxDrainDurationSeconds

default java.lang.Number getMaxDrainDurationSeconds()

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

Default value is 350 seconds.

getPrivateIpAddress

default java.lang.String getPrivateIpAddress()

The private IPv4 address to assign to the NAT gateway.

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

getSecondaryAllocationIds

default java.util.List<java.lang.String> getSecondaryAllocationIds()

Secondary EIP allocation IDs.

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

getSecondaryPrivateIpAddressCount

default java.lang.Number getSecondaryPrivateIpAddressCount()

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

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.

getSecondaryPrivateIpAddresses

default java.util.List<java.lang.String> getSecondaryPrivateIpAddresses()

Secondary private IPv4 addresses.

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.

getTags

default java.util.List<CfnTag> getTags()

The tags for the NAT gateway.

builder

static CfnNatGatewayProps.Builder builder()

Returns:

a CfnNatGatewayProps.Builder of CfnNatGatewayProps