Class CreateNatGatewayRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateNatGatewayRequest.Builder,
CreateNatGatewayRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
[Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway.builder()
final String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final ConnectivityType
Indicates whether the NAT gateway supports public or private connectivity.final String
Indicates whether the NAT gateway supports public or private connectivity.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SecondaryAllocationIds property.final boolean
For responses, this returns true if the service returned a value for the SecondaryPrivateIpAddresses property.final boolean
For responses, this returns true if the service returned a value for the TagSpecifications property.final String
The private IPv4 address to assign to the NAT gateway.Secondary EIP allocation IDs.final Integer
[Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.Secondary private IPv4 addresses.static Class
<? extends CreateNatGatewayRequest.Builder> final String
subnetId()
The ID of the subnet in which to create the NAT gateway.final List
<TagSpecification> The tags to assign to the NAT gateway.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
allocationId
[Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.
- Returns:
- [Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.
-
clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 64 ASCII characters.
- Returns:
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
information, see Ensuring
idempotency.
Constraint: Maximum 64 ASCII characters.
-
dryRun
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
subnetId
The ID of the subnet in which to create the NAT gateway.
- Returns:
- The ID of the subnet in which to create the NAT gateway.
-
hasTagSpecifications
public final boolean hasTagSpecifications()For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tagSpecifications
The tags to assign to the NAT gateway.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTagSpecifications()
method.- Returns:
- The tags to assign to the NAT gateway.
-
connectivityType
Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
If the service returns an enum value that is not available in the current SDK version,
connectivityType
will returnConnectivityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectivityTypeAsString()
.- Returns:
- Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
- See Also:
-
connectivityTypeAsString
Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
If the service returns an enum value that is not available in the current SDK version,
connectivityType
will returnConnectivityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectivityTypeAsString()
.- Returns:
- Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
- See Also:
-
privateIpAddress
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.
- Returns:
- 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.
-
hasSecondaryAllocationIds
public final boolean hasSecondaryAllocationIds()For responses, this returns true if the service returned a value for the SecondaryAllocationIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondaryAllocationIds
Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondaryAllocationIds()
method.- Returns:
- Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.
-
hasSecondaryPrivateIpAddresses
public final boolean hasSecondaryPrivateIpAddresses()For responses, this returns true if the service returned a value for the SecondaryPrivateIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
secondaryPrivateIpAddresses
Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSecondaryPrivateIpAddresses()
method.- Returns:
- Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.
-
secondaryPrivateIpAddressCount
[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 VPC User Guide.
- Returns:
- [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 VPC User Guide.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateNatGatewayRequest.Builder,
CreateNatGatewayRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-