@Generated(value="software.amazon.awssdk:codegen") public class CreateVpcEndpointRequest extends EC2Request implements ToCopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>
Contains the parameters for CreateVpcEndpoint.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateVpcEndpointRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateVpcEndpointRequest.Builder |
builder() |
String |
clientToken()
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
policyDocument()
(Gateway endpoint) A policy to attach to the endpoint that controls access to the service.
|
Boolean |
privateDnsEnabled()
(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC.
|
List<String> |
routeTableIds()
(Gateway endpoint) One or more route table IDs.
|
List<String> |
securityGroupIds()
(Interface endpoint) The ID of one or more security groups to associate with the network interface.
|
static Class<? extends CreateVpcEndpointRequest.Builder> |
serializableBuilderClass() |
String |
serviceName()
The AWS service name, in the form
com.amazonaws.region.service . |
List<String> |
subnetIds()
(Interface endpoint) The ID of one or more subnets in which to create a network interface for the endpoint.
|
CreateVpcEndpointRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
VpcEndpointType |
vpcEndpointType()
The type of endpoint.
|
String |
vpcEndpointTypeString()
The type of endpoint.
|
String |
vpcId()
The ID of the VPC in which the endpoint will be used.
|
requestOverrideConfig
copy
public VpcEndpointType vpcEndpointType()
The type of endpoint. If not specified, the default is a gateway endpoint.
If the service returns an enum value that is not available in the current SDK version, vpcEndpointType
will return VpcEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from vpcEndpointTypeString()
.
VpcEndpointType
public String vpcEndpointTypeString()
The type of endpoint. If not specified, the default is a gateway endpoint.
If the service returns an enum value that is not available in the current SDK version, vpcEndpointType
will return VpcEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from vpcEndpointTypeString()
.
VpcEndpointType
public String vpcId()
The ID of the VPC in which the endpoint will be used.
public String serviceName()
The AWS service name, in the form com.amazonaws.region.service
. To get a list of
available services, use the DescribeVpcEndpointServices request.
com.amazonaws.region.service
. To get a list
of available services, use the DescribeVpcEndpointServices request.public String policyDocument()
(Gateway endpoint) 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.
public List<String> routeTableIds()
(Gateway endpoint) One or more route table IDs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> subnetIds()
(Interface endpoint) The ID of one or more subnets in which to create a network interface for the endpoint.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> securityGroupIds()
(Interface endpoint) The ID of one or more security groups to associate with the network interface.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String clientToken()
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
public Boolean privateDnsEnabled()
(Interface endpoint) Indicate 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
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
public CreateVpcEndpointRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateVpcEndpointRequest.Builder,CreateVpcEndpointRequest>
toBuilder
in class EC2Request
public static CreateVpcEndpointRequest.Builder builder()
public static Class<? extends CreateVpcEndpointRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.