Interface NatGateway.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<NatGateway.Builder,NatGateway>
,SdkBuilder<NatGateway.Builder,NatGateway>
,SdkPojo
- Enclosing class:
- NatGateway
public static interface NatGateway.Builder extends SdkPojo, CopyableBuilder<NatGateway.Builder,NatGateway>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description NatGateway.Builder
connectivityType(String connectivityType)
Indicates whether the NAT gateway supports public or private connectivity.NatGateway.Builder
connectivityType(ConnectivityType connectivityType)
Indicates whether the NAT gateway supports public or private connectivity.NatGateway.Builder
createTime(Instant createTime)
The date and time the NAT gateway was created.NatGateway.Builder
deleteTime(Instant deleteTime)
The date and time the NAT gateway was deleted, if applicable.NatGateway.Builder
failureCode(String failureCode)
If the NAT gateway could not be created, specifies the error code for the failure.NatGateway.Builder
failureMessage(String failureMessage)
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.NatGateway.Builder
natGatewayAddresses(Collection<NatGatewayAddress> natGatewayAddresses)
Information about the IP addresses and network interface associated with the NAT gateway.NatGateway.Builder
natGatewayAddresses(Consumer<NatGatewayAddress.Builder>... natGatewayAddresses)
Information about the IP addresses and network interface associated with the NAT gateway.NatGateway.Builder
natGatewayAddresses(NatGatewayAddress... natGatewayAddresses)
Information about the IP addresses and network interface associated with the NAT gateway.NatGateway.Builder
natGatewayId(String natGatewayId)
The ID of the NAT gateway.default NatGateway.Builder
provisionedBandwidth(Consumer<ProvisionedBandwidth.Builder> provisionedBandwidth)
Reserved.NatGateway.Builder
provisionedBandwidth(ProvisionedBandwidth provisionedBandwidth)
Reserved.NatGateway.Builder
state(String state)
The state of the NAT gateway.NatGateway.Builder
state(NatGatewayState state)
The state of the NAT gateway.NatGateway.Builder
subnetId(String subnetId)
The ID of the subnet in which the NAT gateway is located.NatGateway.Builder
tags(Collection<Tag> tags)
The tags for the NAT gateway.NatGateway.Builder
tags(Consumer<Tag.Builder>... tags)
The tags for the NAT gateway.NatGateway.Builder
tags(Tag... tags)
The tags for the NAT gateway.NatGateway.Builder
vpcId(String vpcId)
The ID of the VPC in which the NAT gateway is located.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
createTime
NatGateway.Builder createTime(Instant createTime)
The date and time the NAT gateway was created.
- Parameters:
createTime
- The date and time the NAT gateway was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deleteTime
NatGateway.Builder deleteTime(Instant deleteTime)
The date and time the NAT gateway was deleted, if applicable.
- Parameters:
deleteTime
- The date and time the NAT gateway was deleted, if applicable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureCode
NatGateway.Builder failureCode(String failureCode)
If the NAT gateway could not be created, specifies the error code for the failure. (
InsufficientFreeAddressesInSubnet
|Gateway.NotAttached
|InvalidAllocationID.NotFound
|Resource.AlreadyAssociated
|InternalError
|InvalidSubnetID.NotFound
)- Parameters:
failureCode
- If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet
|Gateway.NotAttached
|InvalidAllocationID.NotFound
|Resource.AlreadyAssociated
|InternalError
|InvalidSubnetID.NotFound
)- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureMessage
NatGateway.Builder failureMessage(String failureMessage)
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
-
For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
-
For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
-
For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
-
For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
-
For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
-
For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
- Parameters:
failureMessage
- If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.-
For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
-
For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
-
For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
-
For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
-
For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
-
For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
natGatewayAddresses
NatGateway.Builder natGatewayAddresses(Collection<NatGatewayAddress> natGatewayAddresses)
Information about the IP addresses and network interface associated with the NAT gateway.
- Parameters:
natGatewayAddresses
- Information about the IP addresses and network interface associated with the NAT gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
natGatewayAddresses
NatGateway.Builder natGatewayAddresses(NatGatewayAddress... natGatewayAddresses)
Information about the IP addresses and network interface associated with the NAT gateway.
- Parameters:
natGatewayAddresses
- Information about the IP addresses and network interface associated with the NAT gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
natGatewayAddresses
NatGateway.Builder natGatewayAddresses(Consumer<NatGatewayAddress.Builder>... natGatewayAddresses)
Information about the IP addresses and network interface associated with the NAT gateway.
This is a convenience method that creates an instance of theNatGatewayAddress.Builder
avoiding the need to create one manually viaNatGatewayAddress.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#natGatewayAddresses(List
.) - Parameters:
natGatewayAddresses
- a consumer that will call methods onNatGatewayAddress.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#natGatewayAddresses(java.util.Collection
)
-
natGatewayId
NatGateway.Builder natGatewayId(String natGatewayId)
The ID of the NAT gateway.
- Parameters:
natGatewayId
- The ID of the NAT gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedBandwidth
NatGateway.Builder provisionedBandwidth(ProvisionedBandwidth provisionedBandwidth)
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
- Parameters:
provisionedBandwidth
- Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisionedBandwidth
default NatGateway.Builder provisionedBandwidth(Consumer<ProvisionedBandwidth.Builder> provisionedBandwidth)
Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
This is a convenience method that creates an instance of theProvisionedBandwidth.Builder
avoiding the need to create one manually viaProvisionedBandwidth.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovisionedBandwidth(ProvisionedBandwidth)
.- Parameters:
provisionedBandwidth
- a consumer that will call methods onProvisionedBandwidth.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
provisionedBandwidth(ProvisionedBandwidth)
-
state
NatGateway.Builder state(String state)
The state of the NAT gateway.
-
pending
: The NAT gateway is being created and is not ready to process traffic. -
failed
: The NAT gateway could not be created. Check thefailureCode
andfailureMessage
fields for the reason. -
available
: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway. -
deleting
: The NAT gateway is in the process of being terminated and may still be processing traffic. -
deleted
: The NAT gateway has been terminated and is no longer processing traffic.
- Parameters:
state
- The state of the NAT gateway.-
pending
: The NAT gateway is being created and is not ready to process traffic. -
failed
: The NAT gateway could not be created. Check thefailureCode
andfailureMessage
fields for the reason. -
available
: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway. -
deleting
: The NAT gateway is in the process of being terminated and may still be processing traffic. -
deleted
: The NAT gateway has been terminated and is no longer processing traffic.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
NatGatewayState
,NatGatewayState
-
-
state
NatGateway.Builder state(NatGatewayState state)
The state of the NAT gateway.
-
pending
: The NAT gateway is being created and is not ready to process traffic. -
failed
: The NAT gateway could not be created. Check thefailureCode
andfailureMessage
fields for the reason. -
available
: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway. -
deleting
: The NAT gateway is in the process of being terminated and may still be processing traffic. -
deleted
: The NAT gateway has been terminated and is no longer processing traffic.
- Parameters:
state
- The state of the NAT gateway.-
pending
: The NAT gateway is being created and is not ready to process traffic. -
failed
: The NAT gateway could not be created. Check thefailureCode
andfailureMessage
fields for the reason. -
available
: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway. -
deleting
: The NAT gateway is in the process of being terminated and may still be processing traffic. -
deleted
: The NAT gateway has been terminated and is no longer processing traffic.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
NatGatewayState
,NatGatewayState
-
-
subnetId
NatGateway.Builder subnetId(String subnetId)
The ID of the subnet in which the NAT gateway is located.
- Parameters:
subnetId
- The ID of the subnet in which the NAT gateway is located.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcId
NatGateway.Builder vpcId(String vpcId)
The ID of the VPC in which the NAT gateway is located.
- Parameters:
vpcId
- The ID of the VPC in which the NAT gateway is located.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
NatGateway.Builder tags(Collection<Tag> tags)
The tags for the NAT gateway.
- Parameters:
tags
- The tags for the NAT gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
NatGateway.Builder tags(Tag... tags)
The tags for the NAT gateway.
- Parameters:
tags
- The tags for the NAT gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
NatGateway.Builder tags(Consumer<Tag.Builder>... tags)
The tags for the NAT gateway.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
connectivityType
NatGateway.Builder connectivityType(String connectivityType)
Indicates whether the NAT gateway supports public or private connectivity.
- Parameters:
connectivityType
- Indicates whether the NAT gateway supports public or private connectivity.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ConnectivityType
,ConnectivityType
-
connectivityType
NatGateway.Builder connectivityType(ConnectivityType connectivityType)
Indicates whether the NAT gateway supports public or private connectivity.
- Parameters:
connectivityType
- Indicates whether the NAT gateway supports public or private connectivity.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ConnectivityType
,ConnectivityType
-
-