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

Interface CreateCustomerGatewayRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>, Ec2Request.Builder, SdkBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateCustomerGatewayRequest

@Mutable
@NotThreadSafe
public static interface CreateCustomerGatewayRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateCustomerGatewayRequest.Builder,CreateCustomerGatewayRequest>

Method Summary

Modifier and Type	Method	Description
CreateCustomerGatewayRequest.Builder	bgpAsn(Integer bgpAsn)	For customer gateway devices that support BGP, specify the device's ASN.
CreateCustomerGatewayRequest.Builder	bgpAsnExtended(Long bgpAsnExtended)	For customer gateway devices that support BGP, specify the device's ASN.
CreateCustomerGatewayRequest.Builder	certificateArn(String certificateArn)	The Amazon Resource Name (ARN) for the customer gateway certificate.
CreateCustomerGatewayRequest.Builder	deviceName(String deviceName)	A name for the customer gateway device.
CreateCustomerGatewayRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
CreateCustomerGatewayRequest.Builder	ipAddress(String ipAddress)	IPv4 address for the customer gateway device's outside interface.
CreateCustomerGatewayRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateCustomerGatewayRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateCustomerGatewayRequest.Builder	publicIp(String publicIp)	This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface.
CreateCustomerGatewayRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications)	The tags to apply to the customer gateway.
CreateCustomerGatewayRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)	The tags to apply to the customer gateway.
CreateCustomerGatewayRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications)	The tags to apply to the customer gateway.
CreateCustomerGatewayRequest.Builder	type(String type)	The type of VPN connection that this customer gateway supports (ipsec.1).
CreateCustomerGatewayRequest.Builder	type(GatewayType type)	The type of VPN connection that this customer gateway supports (ipsec.1).

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

bgpAsn

CreateCustomerGatewayRequest.Builder bgpAsn(Integer bgpAsn)

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

Parameters:

bgpAsn - For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Default: 65000

Valid values: 1 to 2,147,483,647

Returns:

Returns a reference to this object so that method calls can be chained together.

publicIp

CreateCustomerGatewayRequest.Builder publicIp(String publicIp)

This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Parameters:

publicIp - This member has been deprecated. The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateArn

CreateCustomerGatewayRequest.Builder certificateArn(String certificateArn)

The Amazon Resource Name (ARN) for the customer gateway certificate.

Parameters:

certificateArn - The Amazon Resource Name (ARN) for the customer gateway certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

CreateCustomerGatewayRequest.Builder type(String type)

The type of VPN connection that this customer gateway supports (ipsec.1).

Parameters:

type - The type of VPN connection that this customer gateway supports (ipsec.1).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GatewayType, GatewayType

type

CreateCustomerGatewayRequest.Builder type(GatewayType type)

The type of VPN connection that this customer gateway supports (ipsec.1).

Parameters:

type - The type of VPN connection that this customer gateway supports (ipsec.1).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GatewayType, GatewayType

tagSpecifications

CreateCustomerGatewayRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the customer gateway.

Parameters:

tagSpecifications - The tags to apply to the customer gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateCustomerGatewayRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the customer gateway.

Parameters:

tagSpecifications - The tags to apply to the customer gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagSpecifications

CreateCustomerGatewayRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

The tags to apply to the customer gateway.

This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tagSpecifications(List).

Parameters:

tagSpecifications - a consumer that will call methods on TagSpecification.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tagSpecifications(java.util.Collection)

deviceName

CreateCustomerGatewayRequest.Builder deviceName(String deviceName)

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Parameters:

deviceName - A name for the customer gateway device.

Length Constraints: Up to 255 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

ipAddress

CreateCustomerGatewayRequest.Builder ipAddress(String ipAddress)

IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

Parameters:

ipAddress - IPv4 address for the customer gateway device's outside interface. The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4, you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4, you can use a public IPv4 address.

Returns:

Returns a reference to this object so that method calls can be chained together.

bgpAsnExtended

CreateCustomerGatewayRequest.Builder bgpAsnExtended(Long bgpAsnExtended)

For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

Parameters:

bgpAsnExtended - For customer gateway devices that support BGP, specify the device's ASN. You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647, you must use BgpAsnExtended.

Valid values: 2,147,483,648 to 4,294,967,295

Returns:

Returns a reference to this object so that method calls can be chained together.

dryRun

CreateCustomerGatewayRequest.Builder dryRun(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateCustomerGatewayRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateCustomerGatewayRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder