software.amazon.awssdk.services.ec2.model.CreateNatGatewayRequest Maven / Gradle / Ivy
Show all versions of ec2 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ec2.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.DefaultValueTrait;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateNatGatewayRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField ALLOCATION_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("AllocationId")
.getter(getter(CreateNatGatewayRequest::allocationId))
.setter(setter(Builder::allocationId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AllocationId")
.unmarshallLocationName("AllocationId").build()).build();
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ClientToken")
.getter(getter(CreateNatGatewayRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientToken")
.unmarshallLocationName("ClientToken").build(), DefaultValueTrait.idempotencyToken()).build();
private static final SdkField DRY_RUN_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("DryRun")
.getter(getter(CreateNatGatewayRequest::dryRun))
.setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun")
.unmarshallLocationName("DryRun").build()).build();
private static final SdkField SUBNET_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SubnetId")
.getter(getter(CreateNatGatewayRequest::subnetId))
.setter(setter(Builder::subnetId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubnetId")
.unmarshallLocationName("SubnetId").build()).build();
private static final SdkField> TAG_SPECIFICATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TagSpecifications")
.getter(getter(CreateNatGatewayRequest::tagSpecifications))
.setter(setter(Builder::tagSpecifications))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TagSpecification")
.unmarshallLocationName("TagSpecification").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(TagSpecification::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField CONNECTIVITY_TYPE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ConnectivityType")
.getter(getter(CreateNatGatewayRequest::connectivityTypeAsString))
.setter(setter(Builder::connectivityType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ConnectivityType")
.unmarshallLocationName("ConnectivityType").build()).build();
private static final SdkField PRIVATE_IP_ADDRESS_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("PrivateIpAddress")
.getter(getter(CreateNatGatewayRequest::privateIpAddress))
.setter(setter(Builder::privateIpAddress))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PrivateIpAddress")
.unmarshallLocationName("PrivateIpAddress").build()).build();
private static final SdkField> SECONDARY_ALLOCATION_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SecondaryAllocationIds")
.getter(getter(CreateNatGatewayRequest::secondaryAllocationIds))
.setter(setter(Builder::secondaryAllocationIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecondaryAllocationId")
.unmarshallLocationName("SecondaryAllocationId").build(),
ListTrait
.builder()
.memberLocationName("AllocationId")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("AllocationId").unmarshallLocationName("AllocationId").build())
.build()).build()).build();
private static final SdkField> SECONDARY_PRIVATE_IP_ADDRESSES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SecondaryPrivateIpAddresses")
.getter(getter(CreateNatGatewayRequest::secondaryPrivateIpAddresses))
.setter(setter(Builder::secondaryPrivateIpAddresses))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecondaryPrivateIpAddress")
.unmarshallLocationName("SecondaryPrivateIpAddress").build(),
ListTrait
.builder()
.memberLocationName("item")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Item").unmarshallLocationName("item").build()).build())
.build()).build();
private static final SdkField SECONDARY_PRIVATE_IP_ADDRESS_COUNT_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("SecondaryPrivateIpAddressCount")
.getter(getter(CreateNatGatewayRequest::secondaryPrivateIpAddressCount))
.setter(setter(Builder::secondaryPrivateIpAddressCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SecondaryPrivateIpAddressCount")
.unmarshallLocationName("SecondaryPrivateIpAddressCount").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ALLOCATION_ID_FIELD,
CLIENT_TOKEN_FIELD, DRY_RUN_FIELD, SUBNET_ID_FIELD, TAG_SPECIFICATIONS_FIELD, CONNECTIVITY_TYPE_FIELD,
PRIVATE_IP_ADDRESS_FIELD, SECONDARY_ALLOCATION_IDS_FIELD, SECONDARY_PRIVATE_IP_ADDRESSES_FIELD,
SECONDARY_PRIVATE_IP_ADDRESS_COUNT_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("AllocationId", ALLOCATION_ID_FIELD);
put("ClientToken", CLIENT_TOKEN_FIELD);
put("DryRun", DRY_RUN_FIELD);
put("SubnetId", SUBNET_ID_FIELD);
put("TagSpecification", TAG_SPECIFICATIONS_FIELD);
put("ConnectivityType", CONNECTIVITY_TYPE_FIELD);
put("PrivateIpAddress", PRIVATE_IP_ADDRESS_FIELD);
put("SecondaryAllocationId", SECONDARY_ALLOCATION_IDS_FIELD);
put("SecondaryPrivateIpAddress", SECONDARY_PRIVATE_IP_ADDRESSES_FIELD);
put("SecondaryPrivateIpAddressCount", SECONDARY_PRIVATE_IP_ADDRESS_COUNT_FIELD);
}
});
private final String allocationId;
private final String clientToken;
private final Boolean dryRun;
private final String subnetId;
private final List tagSpecifications;
private final String connectivityType;
private final String privateIpAddress;
private final List secondaryAllocationIds;
private final List secondaryPrivateIpAddresses;
private final Integer secondaryPrivateIpAddressCount;
private CreateNatGatewayRequest(BuilderImpl builder) {
super(builder);
this.allocationId = builder.allocationId;
this.clientToken = builder.clientToken;
this.dryRun = builder.dryRun;
this.subnetId = builder.subnetId;
this.tagSpecifications = builder.tagSpecifications;
this.connectivityType = builder.connectivityType;
this.privateIpAddress = builder.privateIpAddress;
this.secondaryAllocationIds = builder.secondaryAllocationIds;
this.secondaryPrivateIpAddresses = builder.secondaryPrivateIpAddresses;
this.secondaryPrivateIpAddressCount = builder.secondaryPrivateIpAddressCount;
}
/**
*
* [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.
*
*
* @return [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.
*/
public final String allocationId() {
return allocationId;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String clientToken() {
return clientToken;
}
/**
*
* 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 is UnauthorizedOperation
.
*
*
* @return 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 is UnauthorizedOperation
.
*/
public final Boolean dryRun() {
return dryRun;
}
/**
*
* The ID of the subnet in which to create the NAT gateway.
*
*
* @return The ID of the subnet in which to create the NAT gateway.
*/
public final String subnetId() {
return subnetId;
}
/**
* 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 {@code 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.
*/
public final boolean hasTagSpecifications() {
return tagSpecifications != null && !(tagSpecifications instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasTagSpecifications} method.
*
*
* @return The tags to assign to the NAT gateway.
*/
public final List tagSpecifications() {
return tagSpecifications;
}
/**
*
* 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, {@link #connectivityType}
* will return {@link ConnectivityType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #connectivityTypeAsString}.
*
*
* @return Indicates whether the NAT gateway supports public or private connectivity. The default is public
* connectivity.
* @see ConnectivityType
*/
public final ConnectivityType connectivityType() {
return ConnectivityType.fromValue(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, {@link #connectivityType}
* will return {@link ConnectivityType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #connectivityTypeAsString}.
*
*
* @return Indicates whether the NAT gateway supports public or private connectivity. The default is public
* connectivity.
* @see ConnectivityType
*/
public final String connectivityTypeAsString() {
return connectivityType;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String privateIpAddress() {
return privateIpAddress;
}
/**
* 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 {@code 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.
*/
public final boolean hasSecondaryAllocationIds() {
return secondaryAllocationIds != null && !(secondaryAllocationIds instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasSecondaryAllocationIds} method.
*
*
* @return Secondary EIP allocation IDs. For more information, see Create a NAT
* gateway in the Amazon VPC User Guide.
*/
public final List secondaryAllocationIds() {
return secondaryAllocationIds;
}
/**
* 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 {@code 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.
*/
public final boolean hasSecondaryPrivateIpAddresses() {
return secondaryPrivateIpAddresses != null && !(secondaryPrivateIpAddresses instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasSecondaryPrivateIpAddresses} method.
*
*
* @return Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT
* gateway in the Amazon VPC User Guide.
*/
public final List secondaryPrivateIpAddresses() {
return secondaryPrivateIpAddresses;
}
/**
*
* [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.
*
*
* @return [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.
*/
public final Integer secondaryPrivateIpAddressCount() {
return secondaryPrivateIpAddressCount;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(allocationId());
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
hashCode = 31 * hashCode + Objects.hashCode(subnetId());
hashCode = 31 * hashCode + Objects.hashCode(hasTagSpecifications() ? tagSpecifications() : null);
hashCode = 31 * hashCode + Objects.hashCode(connectivityTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(privateIpAddress());
hashCode = 31 * hashCode + Objects.hashCode(hasSecondaryAllocationIds() ? secondaryAllocationIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSecondaryPrivateIpAddresses() ? secondaryPrivateIpAddresses() : null);
hashCode = 31 * hashCode + Objects.hashCode(secondaryPrivateIpAddressCount());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateNatGatewayRequest)) {
return false;
}
CreateNatGatewayRequest other = (CreateNatGatewayRequest) obj;
return Objects.equals(allocationId(), other.allocationId()) && Objects.equals(clientToken(), other.clientToken())
&& Objects.equals(dryRun(), other.dryRun()) && Objects.equals(subnetId(), other.subnetId())
&& hasTagSpecifications() == other.hasTagSpecifications()
&& Objects.equals(tagSpecifications(), other.tagSpecifications())
&& Objects.equals(connectivityTypeAsString(), other.connectivityTypeAsString())
&& Objects.equals(privateIpAddress(), other.privateIpAddress())
&& hasSecondaryAllocationIds() == other.hasSecondaryAllocationIds()
&& Objects.equals(secondaryAllocationIds(), other.secondaryAllocationIds())
&& hasSecondaryPrivateIpAddresses() == other.hasSecondaryPrivateIpAddresses()
&& Objects.equals(secondaryPrivateIpAddresses(), other.secondaryPrivateIpAddresses())
&& Objects.equals(secondaryPrivateIpAddressCount(), other.secondaryPrivateIpAddressCount());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateNatGatewayRequest").add("AllocationId", allocationId()).add("ClientToken", clientToken())
.add("DryRun", dryRun()).add("SubnetId", subnetId())
.add("TagSpecifications", hasTagSpecifications() ? tagSpecifications() : null)
.add("ConnectivityType", connectivityTypeAsString()).add("PrivateIpAddress", privateIpAddress())
.add("SecondaryAllocationIds", hasSecondaryAllocationIds() ? secondaryAllocationIds() : null)
.add("SecondaryPrivateIpAddresses", hasSecondaryPrivateIpAddresses() ? secondaryPrivateIpAddresses() : null)
.add("SecondaryPrivateIpAddressCount", secondaryPrivateIpAddressCount()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AllocationId":
return Optional.ofNullable(clazz.cast(allocationId()));
case "ClientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
case "SubnetId":
return Optional.ofNullable(clazz.cast(subnetId()));
case "TagSpecifications":
return Optional.ofNullable(clazz.cast(tagSpecifications()));
case "ConnectivityType":
return Optional.ofNullable(clazz.cast(connectivityTypeAsString()));
case "PrivateIpAddress":
return Optional.ofNullable(clazz.cast(privateIpAddress()));
case "SecondaryAllocationIds":
return Optional.ofNullable(clazz.cast(secondaryAllocationIds()));
case "SecondaryPrivateIpAddresses":
return Optional.ofNullable(clazz.cast(secondaryPrivateIpAddresses()));
case "SecondaryPrivateIpAddressCount":
return Optional.ofNullable(clazz.cast(secondaryPrivateIpAddressCount()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function