@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<CreateVpcEndpointRequest>
NOOP
Constructor and Description |
---|
CreateVpcEndpointRequest() |
Modifier and Type | Method and Description |
---|---|
CreateVpcEndpointRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
DnsOptionsSpecification |
getDnsOptions()
The DNS options for the endpoint.
|
Request<CreateVpcEndpointRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
String |
getIpAddressType()
The IP address type for the endpoint.
|
String |
getPolicyDocument()
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.
|
Boolean |
getPrivateDnsEnabled()
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.
|
List<String> |
getRouteTableIds()
(Gateway endpoint) The route table IDs.
|
List<String> |
getSecurityGroupIds()
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.
|
String |
getServiceName()
The name of the endpoint service.
|
List<SubnetConfiguration> |
getSubnetConfigurations()
The subnet configurations for the endpoint.
|
List<String> |
getSubnetIds()
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network
interfaces.
|
List<TagSpecification> |
getTagSpecifications()
The tags to associate with the endpoint.
|
String |
getVpcEndpointType()
The type of endpoint.
|
String |
getVpcId()
The ID of the VPC.
|
int |
hashCode() |
Boolean |
isPrivateDnsEnabled()
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.
|
void |
setClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
void |
setDnsOptions(DnsOptionsSpecification dnsOptions)
The DNS options for the endpoint.
|
void |
setIpAddressType(String ipAddressType)
The IP address type for the endpoint.
|
void |
setPolicyDocument(String policyDocument)
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.
|
void |
setPrivateDnsEnabled(Boolean privateDnsEnabled)
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.
|
void |
setRouteTableIds(Collection<String> routeTableIds)
(Gateway endpoint) The route table IDs.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.
|
void |
setServiceName(String serviceName)
The name of the endpoint service.
|
void |
setSubnetConfigurations(Collection<SubnetConfiguration> subnetConfigurations)
The subnet configurations for the endpoint.
|
void |
setSubnetIds(Collection<String> subnetIds)
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network
interfaces.
|
void |
setTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to associate with the endpoint.
|
void |
setVpcEndpointType(String vpcEndpointType)
The type of endpoint.
|
void |
setVpcId(String vpcId)
The ID of the VPC.
|
String |
toString()
Returns a string representation of this object.
|
CreateVpcEndpointRequest |
withClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
CreateVpcEndpointRequest |
withDnsOptions(DnsOptionsSpecification dnsOptions)
The DNS options for the endpoint.
|
CreateVpcEndpointRequest |
withIpAddressType(IpAddressType ipAddressType)
The IP address type for the endpoint.
|
CreateVpcEndpointRequest |
withIpAddressType(String ipAddressType)
The IP address type for the endpoint.
|
CreateVpcEndpointRequest |
withPolicyDocument(String policyDocument)
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service.
|
CreateVpcEndpointRequest |
withPrivateDnsEnabled(Boolean privateDnsEnabled)
(Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC.
|
CreateVpcEndpointRequest |
withRouteTableIds(Collection<String> routeTableIds)
(Gateway endpoint) The route table IDs.
|
CreateVpcEndpointRequest |
withRouteTableIds(String... routeTableIds)
(Gateway endpoint) The route table IDs.
|
CreateVpcEndpointRequest |
withSecurityGroupIds(Collection<String> securityGroupIds)
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.
|
CreateVpcEndpointRequest |
withSecurityGroupIds(String... securityGroupIds)
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.
|
CreateVpcEndpointRequest |
withServiceName(String serviceName)
The name of the endpoint service.
|
CreateVpcEndpointRequest |
withSubnetConfigurations(Collection<SubnetConfiguration> subnetConfigurations)
The subnet configurations for the endpoint.
|
CreateVpcEndpointRequest |
withSubnetConfigurations(SubnetConfiguration... subnetConfigurations)
The subnet configurations for the endpoint.
|
CreateVpcEndpointRequest |
withSubnetIds(Collection<String> subnetIds)
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network
interfaces.
|
CreateVpcEndpointRequest |
withSubnetIds(String... subnetIds)
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network
interfaces.
|
CreateVpcEndpointRequest |
withTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to associate with the endpoint.
|
CreateVpcEndpointRequest |
withTagSpecifications(TagSpecification... tagSpecifications)
The tags to associate with the endpoint.
|
CreateVpcEndpointRequest |
withVpcEndpointType(String vpcEndpointType)
The type of endpoint.
|
CreateVpcEndpointRequest |
withVpcEndpointType(VpcEndpointType vpcEndpointType)
The type of endpoint.
|
CreateVpcEndpointRequest |
withVpcId(String vpcId)
The ID of the VPC.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setVpcEndpointType(String vpcEndpointType)
The type of endpoint.
Default: Gateway
vpcEndpointType
- The type of endpoint.
Default: Gateway
VpcEndpointType
public String getVpcEndpointType()
The type of endpoint.
Default: Gateway
Default: Gateway
VpcEndpointType
public CreateVpcEndpointRequest withVpcEndpointType(String vpcEndpointType)
The type of endpoint.
Default: Gateway
vpcEndpointType
- The type of endpoint.
Default: Gateway
VpcEndpointType
public CreateVpcEndpointRequest withVpcEndpointType(VpcEndpointType vpcEndpointType)
The type of endpoint.
Default: Gateway
vpcEndpointType
- The type of endpoint.
Default: Gateway
VpcEndpointType
public void setVpcId(String vpcId)
The ID of the VPC.
vpcId
- The ID of the VPC.public String getVpcId()
The ID of the VPC.
public CreateVpcEndpointRequest withVpcId(String vpcId)
The ID of the VPC.
vpcId
- The ID of the VPC.public void setServiceName(String serviceName)
The name of the endpoint service.
serviceName
- The name of the endpoint service.public String getServiceName()
The name of the endpoint service.
public CreateVpcEndpointRequest withServiceName(String serviceName)
The name of the endpoint service.
serviceName
- The name of the endpoint service.public void setPolicyDocument(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.
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.public String getPolicyDocument()
(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.
public CreateVpcEndpointRequest withPolicyDocument(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.
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.public List<String> getRouteTableIds()
(Gateway endpoint) The route table IDs.
public void setRouteTableIds(Collection<String> routeTableIds)
(Gateway endpoint) The route table IDs.
routeTableIds
- (Gateway endpoint) The route table IDs.public CreateVpcEndpointRequest withRouteTableIds(String... routeTableIds)
(Gateway endpoint) The route table IDs.
NOTE: This method appends the values to the existing list (if any). Use
setRouteTableIds(java.util.Collection)
or withRouteTableIds(java.util.Collection)
if you want
to override the existing values.
routeTableIds
- (Gateway endpoint) The route table IDs.public CreateVpcEndpointRequest withRouteTableIds(Collection<String> routeTableIds)
(Gateway endpoint) The route table IDs.
routeTableIds
- (Gateway endpoint) The route table IDs.public List<String> getSubnetIds()
(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.
public void setSubnetIds(Collection<String> 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.
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.public CreateVpcEndpointRequest withSubnetIds(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setSubnetIds(java.util.Collection)
or withSubnetIds(java.util.Collection)
if you want to
override the existing values.
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.public CreateVpcEndpointRequest withSubnetIds(Collection<String> 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.
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.public List<String> getSecurityGroupIds()
(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.
public void setSecurityGroupIds(Collection<String> 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.
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.public CreateVpcEndpointRequest withSecurityGroupIds(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroupIds(java.util.Collection)
or withSecurityGroupIds(java.util.Collection)
if you
want to override the existing values.
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.public CreateVpcEndpointRequest withSecurityGroupIds(Collection<String> 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.
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.public void setIpAddressType(String ipAddressType)
The IP address type for the endpoint.
ipAddressType
- The IP address type for the endpoint.IpAddressType
public String getIpAddressType()
The IP address type for the endpoint.
IpAddressType
public CreateVpcEndpointRequest withIpAddressType(String ipAddressType)
The IP address type for the endpoint.
ipAddressType
- The IP address type for the endpoint.IpAddressType
public CreateVpcEndpointRequest withIpAddressType(IpAddressType ipAddressType)
The IP address type for the endpoint.
ipAddressType
- The IP address type for the endpoint.IpAddressType
public void setDnsOptions(DnsOptionsSpecification dnsOptions)
The DNS options for the endpoint.
dnsOptions
- The DNS options for the endpoint.public DnsOptionsSpecification getDnsOptions()
The DNS options for the endpoint.
public CreateVpcEndpointRequest withDnsOptions(DnsOptionsSpecification dnsOptions)
The DNS options for the endpoint.
dnsOptions
- The DNS options for the endpoint.public void setClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
information, see How to
ensure idempotency.public String getClientToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
public CreateVpcEndpointRequest withClientToken(String clientToken)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
clientToken
- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
information, see How to
ensure idempotency.public void setPrivateDnsEnabled(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
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
public Boolean getPrivateDnsEnabled()
(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
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 withPrivateDnsEnabled(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
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
public Boolean isPrivateDnsEnabled()
(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
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 List<TagSpecification> getTagSpecifications()
The tags to associate with the endpoint.
public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to associate with the endpoint.
tagSpecifications
- The tags to associate with the endpoint.public CreateVpcEndpointRequest withTagSpecifications(TagSpecification... tagSpecifications)
The tags to associate with the endpoint.
NOTE: This method appends the values to the existing list (if any). Use
setTagSpecifications(java.util.Collection)
or withTagSpecifications(java.util.Collection)
if
you want to override the existing values.
tagSpecifications
- The tags to associate with the endpoint.public CreateVpcEndpointRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to associate with the endpoint.
tagSpecifications
- The tags to associate with the endpoint.public List<SubnetConfiguration> getSubnetConfigurations()
The subnet configurations for the endpoint.
public void setSubnetConfigurations(Collection<SubnetConfiguration> subnetConfigurations)
The subnet configurations for the endpoint.
subnetConfigurations
- The subnet configurations for the endpoint.public CreateVpcEndpointRequest withSubnetConfigurations(SubnetConfiguration... subnetConfigurations)
The subnet configurations for the endpoint.
NOTE: This method appends the values to the existing list (if any). Use
setSubnetConfigurations(java.util.Collection)
or withSubnetConfigurations(java.util.Collection)
if you want to override the existing values.
subnetConfigurations
- The subnet configurations for the endpoint.public CreateVpcEndpointRequest withSubnetConfigurations(Collection<SubnetConfiguration> subnetConfigurations)
The subnet configurations for the endpoint.
subnetConfigurations
- The subnet configurations for the endpoint.public Request<CreateVpcEndpointRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<CreateVpcEndpointRequest>
public String toString()
toString
in class Object
Object.toString()
public CreateVpcEndpointRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()