Class CreateCustomerGatewayRequest
- 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.CreateCustomerGatewayRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCustomerGatewayRequest extends Ec2Request implements ToCopyableBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>
Contains the parameters for CreateCustomerGateway.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateCustomerGatewayRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Integer
bgpAsn()
For devices that support BGP, the customer gateway's BGP ASN.static CreateCustomerGatewayRequest.Builder
builder()
String
certificateArn()
The Amazon Resource Name (ARN) for the customer gateway certificate.String
deviceName()
A name for the customer gateway device.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property.String
ipAddress()
IPv4 address for the customer gateway device's outside interface.String
publicIp()
This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface.List<SdkField<?>>
sdkFields()
static Class<? extends CreateCustomerGatewayRequest.Builder>
serializableBuilderClass()
List<TagSpecification>
tagSpecifications()
The tags to apply to the customer gateway.CreateCustomerGatewayRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.GatewayType
type()
The type of VPN connection that this customer gateway supports (ipsec.1
).String
typeAsString()
The type of VPN connection that this customer gateway supports (ipsec.1
).-
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
-
bgpAsn
public final Integer bgpAsn()
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
- Returns:
- For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
-
publicIp
public final String publicIp()
This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
- Returns:
- This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
-
certificateArn
public final String certificateArn()
The Amazon Resource Name (ARN) for the customer gateway certificate.
- Returns:
- The Amazon Resource Name (ARN) for the customer gateway certificate.
-
type
public final GatewayType type()
The type of VPN connection that this customer gateway supports (
ipsec.1
).If the service returns an enum value that is not available in the current SDK version,
type
will returnGatewayType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - See Also:
GatewayType
-
typeAsString
public final String typeAsString()
The type of VPN connection that this customer gateway supports (
ipsec.1
).If the service returns an enum value that is not available in the current SDK version,
type
will returnGatewayType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of VPN connection that this customer gateway supports (
ipsec.1
). - See Also:
GatewayType
-
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
public final List<TagSpecification> tagSpecifications()
The tags to apply to the customer 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 apply to the customer gateway.
-
deviceName
public final String deviceName()
A name for the customer gateway device.
Length Constraints: Up to 255 characters.
- Returns:
- A name for the customer gateway device.
Length Constraints: Up to 255 characters.
-
ipAddress
public final String ipAddress()
IPv4 address for the customer gateway device's outside interface. The address must be static.
- Returns:
- IPv4 address for the customer gateway device's outside interface. The address must be static.
-
dryRun
public final Boolean 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
.
-
toBuilder
public CreateCustomerGatewayRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static CreateCustomerGatewayRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateCustomerGatewayRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-