software.amazon.awssdk.services.ec2.model

Class CreateNatGatewayRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.CreateNatGatewayRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateNatGatewayRequest.Builder,CreateNatGatewayRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateNatGatewayRequest
extends Ec2Request
implements ToCopyableBuilder<CreateNatGatewayRequest.Builder,CreateNatGatewayRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNatGatewayRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	allocationId() [Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway.
static CreateNatGatewayRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
ConnectivityType	connectivityType() Indicates whether the NAT gateway supports public or private connectivity.
String	connectivityTypeAsString() Indicates whether the NAT gateway supports public or private connectivity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecondaryAllocationIds() For responses, this returns true if the service returned a value for the SecondaryAllocationIds property.
boolean	hasSecondaryPrivateIpAddresses() For responses, this returns true if the service returned a value for the SecondaryPrivateIpAddresses property.
boolean	hasTagSpecifications() For responses, this returns true if the service returned a value for the TagSpecifications property.
String	privateIpAddress() The private IPv4 address to assign to the NAT gateway.
List<SdkField<?>>	sdkFields()
List<String>	secondaryAllocationIds() Secondary EIP allocation IDs.
Integer	secondaryPrivateIpAddressCount() [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway.
List<String>	secondaryPrivateIpAddresses() Secondary private IPv4 addresses.
static Class<? extends CreateNatGatewayRequest.Builder>	serializableBuilderClass()
String	subnetId() The ID of the subnet in which to create the NAT gateway.
List<TagSpecification>	tagSpecifications() The tags to assign to the NAT gateway.
CreateNatGatewayRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

allocationId

public final String 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

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure 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 How to ensure idempotency.

Constraint: Maximum 64 ASCII characters.

subnetId

public final String 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 the isEmpty() 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

public final List<TagSpecification> 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

public final ConnectivityType 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 return ConnectivityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectivityTypeAsString().

Returns:

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

See Also:

ConnectivityType

connectivityTypeAsString

public final String 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 return ConnectivityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectivityTypeAsString().

Returns:

Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.

See Also:

ConnectivityType

privateIpAddress

public final String 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 the isEmpty() 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

public final List<String> secondaryAllocationIds()

Secondary EIP allocation IDs. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud 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 about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud 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 the isEmpty() 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

public final List<String> secondaryPrivateIpAddresses()

Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon Virtual Private Cloud 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 Virtual Private Cloud User Guide.

secondaryPrivateIpAddressCount

public final Integer 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 Virtual Private Cloud 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 Virtual Private Cloud User Guide.

toBuilder

public CreateNatGatewayRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateNatGatewayRequest.Builder,CreateNatGatewayRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateNatGatewayRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateNatGatewayRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo