Interface CreateVpcEndpointRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateVpcEndpointRequest.Builder,
,CreateVpcEndpointRequest> Ec2Request.Builder
,SdkBuilder<CreateVpcEndpointRequest.Builder,
,CreateVpcEndpointRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateVpcEndpointRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(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.dnsOptions
(DnsOptionsSpecification dnsOptions) The DNS options for the endpoint.Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.ipAddressType
(String ipAddressType) The IP address type for the endpoint.ipAddressType
(IpAddressType ipAddressType) The IP address type for the endpoint.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.policyDocument
(String policyDocument) (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.privateDnsEnabled
(Boolean privateDnsEnabled) (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.routeTableIds
(String... routeTableIds) (Gateway endpoint) The route table IDs.routeTableIds
(Collection<String> routeTableIds) (Gateway endpoint) The route table IDs.securityGroupIds
(String... securityGroupIds) (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.securityGroupIds
(Collection<String> securityGroupIds) (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.serviceName
(String serviceName) The name of the endpoint service.subnetConfigurations
(Collection<SubnetConfiguration> subnetConfigurations) The subnet configurations for the endpoint.subnetConfigurations
(Consumer<SubnetConfiguration.Builder>... subnetConfigurations) The subnet configurations for the endpoint.subnetConfigurations
(SubnetConfiguration... subnetConfigurations) The subnet configurations for the endpoint.(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces.subnetIds
(Collection<String> subnetIds) (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces.tagSpecifications
(Collection<TagSpecification> tagSpecifications) The tags to associate with the endpoint.tagSpecifications
(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to associate with the endpoint.tagSpecifications
(TagSpecification... tagSpecifications) The tags to associate with the endpoint.vpcEndpointType
(String vpcEndpointType) The type of endpoint.vpcEndpointType
(VpcEndpointType vpcEndpointType) The type of endpoint.The ID of the VPC.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, sdkFields
-
Method Details
-
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
.- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
vpcId
The ID of the VPC.
- Parameters:
vpcId
- The ID of the VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceName
The name of the endpoint service.
- Parameters:
serviceName
- The name of the endpoint service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
(Gateway endpoint) The route table IDs.
- Parameters:
routeTableIds
- (Gateway endpoint) The route table IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
routeTableIds
(Gateway endpoint) The route table IDs.
- Parameters:
routeTableIds
- (Gateway endpoint) The route table IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.
- Parameters:
subnetIds
- (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetIds
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.
- Parameters:
subnetIds
- (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.
- Parameters:
securityGroupIds
- (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.
- Parameters:
securityGroupIds
- (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
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 theDnsOptionsSpecification.Builder
avoiding the need to create one manually viaDnsOptionsSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todnsOptions(DnsOptionsSpecification)
.- Parameters:
dnsOptions
- a consumer that will call methods onDnsOptionsSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
(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
andenableDnsSupport
. 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
andenableDnsSupport
. 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
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
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 theTagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagSpecifications(List<TagSpecification>)
.- Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
subnetConfigurations
CreateVpcEndpointRequest.Builder subnetConfigurations(Collection<SubnetConfiguration> subnetConfigurations) The subnet configurations for the endpoint.
- Parameters:
subnetConfigurations
- The subnet configurations for the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetConfigurations
The subnet configurations for the endpoint.
- Parameters:
subnetConfigurations
- The subnet configurations for the endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subnetConfigurations
CreateVpcEndpointRequest.Builder subnetConfigurations(Consumer<SubnetConfiguration.Builder>... subnetConfigurations) The subnet configurations for the endpoint.
This is a convenience method that creates an instance of theSubnetConfiguration.Builder
avoiding the need to create one manually viaSubnetConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosubnetConfigurations(List<SubnetConfiguration>)
.- Parameters:
subnetConfigurations
- a consumer that will call methods onSubnetConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateVpcEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateVpcEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-