NatGatewayState class
Input properties used for looking up and filtering NatGateway resources.
Constructors
-
NatGatewayState({Input<
String?> ? allocationId, Input<String?> ? associationId, Input<String?> ? autoProvisionZones, Input<String?> ? autoScalingIps, Input<String?> ? availabilityMode, Input<List< ? availabilityZoneAddresses, Input<NatGatewayAvailabilityZoneAddress> ?>String?> ? connectivityType, Input<String?> ? networkInterfaceId, Input<String?> ? privateIp, Input<String?> ? publicIp, Input<String?> ? region, Input<List< ? regionalNatGatewayAddresses, Input<NatGatewayRegionalNatGatewayAddress> ?>String?> ? regionalNatGatewayAutoMode, Input<String?> ? routeTableId, Input<List< ? secondaryAllocationIds, Input<String> ?>int?> ? secondaryPrivateIpAddressCount, Input<List< ? secondaryPrivateIpAddresses, Input<String> ?>String?> ? subnetId, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? vpcId}) -
Creates a new NatGatewayState.
allocationIdThe Allocation ID of the Elastic IP address for the NAT Gateway. Required whenconnectivityTypeis set topublicandavailabilityModeis set tozonal. WhenavailabilityModeis set toregional, this must not be set; instead, use theavailabilityZoneAddressblock to specify EIPs for each AZ.associationIdAssociation ID of the Elastic IP address.autoProvisionZones(regional NAT gateways only) Indicates whether AWS automatically manages AZ coverage.autoScalingIps(regional NAT gateways only) Indicates whether AWS automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.availabilityModeSpecifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Valid values arezonalandregional. Defaults tozonal.availabilityZoneAddressesRepeatable configuration block for the Elastic IP addresses (EIPs) and availability zones for the regional NAT gateway. When not specified, the regional NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface (auto mode). When specified, auto-expansion is disabled (manual mode). SeeavailabilityZoneAddressbelow for details.connectivityTypeConnectivity type for the NAT Gateway. Valid values areprivateandpublic. WhenavailabilityModeis set toregional, this must be set topublic. Defaults topublic.networkInterfaceIdID of the network interface.privateIpThe private IPv4 address to assign to the NAT Gateway. If you don't provide an address, a private IPv4 address will be automatically assigned.publicIpPublic IP address.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.regionalNatGatewayAddresses(regional NAT gateways only) Repeatable blocks for information about the IP addresses and network interface associated with the regional NAT gateway.regionalNatGatewayAutoModeOptional.routeTableId(regional NAT gateways only) ID of the automatically created route table.secondaryAllocationIdsA list of secondary allocation EIP IDs for this NAT Gateway. To remove all secondary allocations an empty list should be specified.secondaryPrivateIpAddressCountThe number of secondary private IPv4 addresses you want to assign to the NAT Gateway.secondaryPrivateIpAddressesA list of secondary private IPv4 addresses to assign to the NAT Gateway. To remove all secondary private addresses an empty list should be specified.subnetIdThe Subnet ID of the subnet in which to place the NAT Gateway. Required whenavailabilityModeis set tozonal. Must not be set whenavailabilityModeis set toregional.tagsA map of tags to assign to the resource. .If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.vpcIdVPC ID where this NAT Gateway will be created. Required whenavailabilityModeis set toregional.const -
NatGatewayState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allocationId
→ Input<
String?> ? -
The Allocation ID of the Elastic IP address for the NAT Gateway. Required when
connectivityTypeis set topublicandavailabilityModeis set tozonal. WhenavailabilityModeis set toregional, this must not be set; instead, use theavailabilityZoneAddressblock to specify EIPs for each AZ.final -
associationId
→ Input<
String?> ? -
Association ID of the Elastic IP address.
final
-
autoProvisionZones
→ Input<
String?> ? -
(regional NAT gateways only) Indicates whether AWS automatically manages AZ coverage.
final
-
autoScalingIps
→ Input<
String?> ? -
(regional NAT gateways only) Indicates whether AWS automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.
final
-
availabilityMode
→ Input<
String?> ? -
Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Valid values are
zonalandregional. Defaults tozonal.final -
availabilityZoneAddresses
→ Input<
List< ?NatGatewayAvailabilityZoneAddress> ?> -
Repeatable configuration block for the Elastic IP addresses (EIPs) and availability zones for the regional NAT gateway. When not specified, the regional NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface (auto mode). When specified, auto-expansion is disabled (manual mode). See
availabilityZoneAddressbelow for details.final -
connectivityType
→ Input<
String?> ? -
Connectivity type for the NAT Gateway. Valid values are
privateandpublic. WhenavailabilityModeis set toregional, this must be set topublic. Defaults topublic.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
networkInterfaceId
→ Input<
String?> ? -
ID of the network interface.
final
-
privateIp
→ Input<
String?> ? -
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.
final
-
publicIp
→ Input<
String?> ? -
Public IP address.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
regionalNatGatewayAddresses
→ Input<
List< ?NatGatewayRegionalNatGatewayAddress> ?> -
(regional NAT gateways only) Repeatable blocks for information about the IP addresses and network interface associated with the regional NAT gateway.
final
-
regionalNatGatewayAutoMode
→ Input<
String?> ? -
final
-
routeTableId
→ Input<
String?> ? -
(regional NAT gateways only) ID of the automatically created route table.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
secondaryAllocationIds
→ Input<
List< ?String> ?> -
A list of secondary allocation EIP IDs for this NAT Gateway. To remove all secondary allocations an empty list should be specified.
final
-
secondaryPrivateIpAddressCount
→ Input<
int?> ? -
The number of secondary private IPv4 addresses you want to assign to the NAT Gateway.
final
-
secondaryPrivateIpAddresses
→ Input<
List< ?String> ?> -
A list of secondary private IPv4 addresses to assign to the NAT Gateway. To remove all secondary private addresses an empty list should be specified.
final
-
subnetId
→ Input<
String?> ? -
The Subnet ID of the subnet in which to place the NAT Gateway. Required when
availabilityModeis set tozonal. Must not be set whenavailabilityModeis set toregional.final -
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
vpcId
→ Input<
String?> ? -
VPC ID where this NAT Gateway will be created. Required when
availabilityModeis set toregional.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited