Package software.amazon.awssdk.services.ec2.model

Class CreateVpnConnectionRequest

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.CreateVpnConnectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateVpnConnectionRequest.Builder,CreateVpnConnectionRequest>

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

Contains the parameters for CreateVpnConnection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateVpnConnectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateVpnConnectionRequest.Builder	builder()
String	customerGatewayId()	The ID of the customer gateway.
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.
VpnConnectionOptionsSpecification	options()	The options for the VPN connection.
String	preSharedKeyStorage()	Specifies the storage mode for the pre-shared key (PSK).
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateVpnConnectionRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications()	The tags to apply to the VPN connection.
CreateVpnConnectionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	transitGatewayId()	The ID of the transit gateway.
String	type()	The type of VPN connection (ipsec.1).
String	vpnConcentratorId()	The ID of the VPN concentrator to associate with the VPN connection.
String	vpnGatewayId()	The ID of the virtual private gateway.

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

customerGatewayId

public final String customerGatewayId()

The ID of the customer gateway.

Returns:

The ID of the customer gateway.

type

public final String type()

The type of VPN connection (ipsec.1).

Returns:

The type of VPN connection (ipsec.1).

vpnGatewayId

public final String vpnGatewayId()

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

Returns:

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

transitGatewayId

public final String transitGatewayId()

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

Returns:

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

vpnConcentratorId

public final String vpnConcentratorId()

The ID of the VPN concentrator to associate with the VPN connection.

Returns:

The ID of the VPN concentrator to associate with the VPN connection.

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 apply to the VPN connection.

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 VPN connection.

preSharedKeyStorage

public final String preSharedKeyStorage()

Specifies the storage mode for the pre-shared key (PSK). Valid values are Standard" (stored in the Site-to-Site VPN service) or SecretsManager (stored in Amazon Web Services Secrets Manager).

Returns:

Specifies the storage mode for the pre-shared key (PSK). Valid values are Standard" (stored in the Site-to-Site VPN service) or SecretsManager (stored in Amazon Web Services Secrets Manager).

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 is UnauthorizedOperation.

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 is UnauthorizedOperation.

options

public final VpnConnectionOptionsSpecification options()

The options for the VPN connection.

Returns:

The options for the VPN connection.

toBuilder

public CreateVpnConnectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateVpnConnectionRequest.Builder,CreateVpnConnectionRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static CreateVpnConnectionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateVpnConnectionRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo