software.amazon.awssdk.services.ec2.model

Interface CreateVpcEndpointRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateVpcEndpointRequest

public static interface CreateVpcEndpointRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>

Method Summary

Modifier and Type	Method and Description
CreateVpcEndpointRequest.Builder	clientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default CreateVpcEndpointRequest.Builder	dnsOptions(Consumer<DnsOptionsSpecification.Builder> dnsOptions) The DNS options for the endpoint.
CreateVpcEndpointRequest.Builder	dnsOptions(DnsOptionsSpecification dnsOptions) The DNS options for the endpoint.
CreateVpcEndpointRequest.Builder	ipAddressType(IpAddressType ipAddressType) The IP address type for the endpoint.
CreateVpcEndpointRequest.Builder	ipAddressType(String ipAddressType) The IP address type for the endpoint.
CreateVpcEndpointRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateVpcEndpointRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateVpcEndpointRequest.Builder	policyDocument(String policyDocument) (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.
CreateVpcEndpointRequest.Builder	privateDnsEnabled(Boolean privateDnsEnabled) (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.
CreateVpcEndpointRequest.Builder	routeTableIds(Collection<String> routeTableIds) (Gateway endpoint) One or more route table IDs.
CreateVpcEndpointRequest.Builder	routeTableIds(String... routeTableIds) (Gateway endpoint) One or more route table IDs.
CreateVpcEndpointRequest.Builder	securityGroupIds(Collection<String> securityGroupIds) (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
CreateVpcEndpointRequest.Builder	securityGroupIds(String... securityGroupIds) (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
CreateVpcEndpointRequest.Builder	serviceName(String serviceName) The service name.
CreateVpcEndpointRequest.Builder	subnetIds(Collection<String> subnetIds) (Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface.
CreateVpcEndpointRequest.Builder	subnetIds(String... subnetIds) (Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface.
CreateVpcEndpointRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to associate with the endpoint.
CreateVpcEndpointRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to associate with the endpoint.
CreateVpcEndpointRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications) The tags to associate with the endpoint.
CreateVpcEndpointRequest.Builder	vpcEndpointType(String vpcEndpointType) The type of endpoint.
CreateVpcEndpointRequest.Builder	vpcEndpointType(VpcEndpointType vpcEndpointType) The type of endpoint.
CreateVpcEndpointRequest.Builder	vpcId(String vpcId) The ID of the VPC in which the endpoint will be used.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

vpcEndpointType

CreateVpcEndpointRequest.Builder vpcEndpointType(String vpcEndpointType)

The type of endpoint.

Default: Gateway

Parameters:

vpcEndpointType - The type of endpoint.

Default: Gateway

Returns:

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

See Also:

VpcEndpointType, VpcEndpointType

vpcEndpointType

CreateVpcEndpointRequest.Builder vpcEndpointType(VpcEndpointType vpcEndpointType)

The type of endpoint.

Default: Gateway

Parameters:

vpcEndpointType - The type of endpoint.

Default: Gateway

Returns:

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

See Also:

VpcEndpointType, VpcEndpointType

vpcId

CreateVpcEndpointRequest.Builder vpcId(String vpcId)

The ID of the VPC in which the endpoint will be used.

Parameters:

vpcId - The ID of the VPC in which the endpoint will be used.

Returns:

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

serviceName

CreateVpcEndpointRequest.Builder serviceName(String serviceName)

The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.

Parameters:

serviceName - The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.

Returns:

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

policyDocument

CreateVpcEndpointRequest.Builder policyDocument(String policyDocument)

(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

Parameters:

policyDocument - (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

Returns:

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

routeTableIds

CreateVpcEndpointRequest.Builder routeTableIds(Collection<String> routeTableIds)

(Gateway endpoint) One or more route table IDs.

Parameters:

routeTableIds - (Gateway endpoint) One or more route table IDs.

Returns:

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

routeTableIds

CreateVpcEndpointRequest.Builder routeTableIds(String... routeTableIds)

(Gateway endpoint) One or more route table IDs.

Parameters:

routeTableIds - (Gateway endpoint) One or more route table IDs.

Returns:

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

subnetIds

CreateVpcEndpointRequest.Builder subnetIds(Collection<String> subnetIds)

(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.

Parameters:

subnetIds - (Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.

Returns:

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

subnetIds

CreateVpcEndpointRequest.Builder subnetIds(String... subnetIds)

(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.

Parameters:

subnetIds - (Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.

Returns:

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

securityGroupIds

CreateVpcEndpointRequest.Builder securityGroupIds(Collection<String> securityGroupIds)

(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.

Parameters:

securityGroupIds - (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.

Returns:

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

securityGroupIds

CreateVpcEndpointRequest.Builder securityGroupIds(String... securityGroupIds)

(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.

Parameters:

securityGroupIds - (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.

Returns:

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

ipAddressType

CreateVpcEndpointRequest.Builder ipAddressType(String ipAddressType)

The IP address type for the endpoint.

Parameters:

ipAddressType - The IP address type for the endpoint.

Returns:

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

See Also:

IpAddressType, IpAddressType

ipAddressType

CreateVpcEndpointRequest.Builder ipAddressType(IpAddressType ipAddressType)

The IP address type for the endpoint.

Parameters:

ipAddressType - The IP address type for the endpoint.

Returns:

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

See Also:

IpAddressType, IpAddressType

dnsOptions

CreateVpcEndpointRequest.Builder dnsOptions(DnsOptionsSpecification dnsOptions)

The DNS options for the endpoint.

Parameters:

dnsOptions - The DNS options for the endpoint.

Returns:

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

dnsOptions

default CreateVpcEndpointRequest.Builder dnsOptions(Consumer<DnsOptionsSpecification.Builder> dnsOptions)

The DNS options for the endpoint.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dnsOptions(DnsOptionsSpecification).

Parameters:

dnsOptions - a consumer that will call methods on DnsOptionsSpecification.Builder

Returns:

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

See Also:

dnsOptions(DnsOptionsSpecification)

clientToken

CreateVpcEndpointRequest.Builder clientToken(String clientToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Returns:

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

privateDnsEnabled

CreateVpcEndpointRequest.Builder privateDnsEnabled(Boolean privateDnsEnabled)

(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

Default: true

Parameters:

privateDnsEnabled - (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

Default: true

Returns:

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

tagSpecifications

CreateVpcEndpointRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to associate with the endpoint.

Parameters:

tagSpecifications - The tags to associate with the endpoint.

Returns:

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

tagSpecifications

CreateVpcEndpointRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to associate with the endpoint.

Parameters:

tagSpecifications - The tags to associate with the endpoint.

Returns:

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

tagSpecifications

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

The tags to associate with the endpoint.

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)

overrideConfiguration

CreateVpcEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder