com.amazonaws.services.ec2.model

Class CreateVpcEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateVpcEndpointRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateVpcEndpointRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateVpcEndpointRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CreateVpcEndpointRequest>

Contains the parameters for CreateVpcEndpoint.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateVpcEndpointRequest()

Method Summary

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.
Request<CreateVpcEndpointRequest>	getDryRunRequest() This method is intended for internal use only.
String	getPolicyDocument() 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) One or more route table IDs.
List<String>	getSecurityGroupIds() (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
String	getServiceName() The service name.
List<String>	getSubnetIds() (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
List<TagSpecification>	getTagSpecifications() The tags to associate with the endpoint.
String	getVpcEndpointType() The type of endpoint.
String	getVpcId() The ID of the VPC in which the endpoint will be used.
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	setPolicyDocument(String policyDocument) 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) One or more route table IDs.
void	setSecurityGroupIds(Collection<String> securityGroupIds) (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
void	setServiceName(String serviceName) The service name.
void	setSubnetIds(Collection<String> subnetIds) (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
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 in which the endpoint will be used.
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	withPolicyDocument(String policyDocument) 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) One or more route table IDs.
CreateVpcEndpointRequest	withRouteTableIds(String... routeTableIds) (Gateway endpoint) One or more route table IDs.
CreateVpcEndpointRequest	withSecurityGroupIds(Collection<String> securityGroupIds) (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
CreateVpcEndpointRequest	withSecurityGroupIds(String... securityGroupIds) (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
CreateVpcEndpointRequest	withServiceName(String serviceName) The service name.
CreateVpcEndpointRequest	withSubnetIds(Collection<String> subnetIds) (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
CreateVpcEndpointRequest	withSubnetIds(String... subnetIds) (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
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 in which the endpoint will be used.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVpcEndpointRequest

public CreateVpcEndpointRequest()

Method Detail

setVpcEndpointType

public void setVpcEndpointType(String vpcEndpointType)

The type of endpoint.

Default: Gateway

Parameters:

vpcEndpointType - The type of endpoint.

Default: Gateway

See Also:

VpcEndpointType

getVpcEndpointType

public String getVpcEndpointType()

The type of endpoint.

Default: Gateway

Returns:

The type of endpoint.

Default: Gateway

See Also:

VpcEndpointType

withVpcEndpointType

public CreateVpcEndpointRequest withVpcEndpointType(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

withVpcEndpointType

public CreateVpcEndpointRequest withVpcEndpointType(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

setVpcId

public void setVpcId(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.

getVpcId

public String getVpcId()

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

Returns:

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

withVpcId

public CreateVpcEndpointRequest withVpcId(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.

setServiceName

public void setServiceName(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.

getServiceName

public String getServiceName()

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

Returns:

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

withServiceName

public CreateVpcEndpointRequest withServiceName(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.

setPolicyDocument

public void setPolicyDocument(String policyDocument)

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 - 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.

getPolicyDocument

public String getPolicyDocument()

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:

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.

withPolicyDocument

public CreateVpcEndpointRequest withPolicyDocument(String policyDocument)

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 - 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.

getRouteTableIds

public List<String> getRouteTableIds()

(Gateway endpoint) One or more route table IDs.

Returns:

(Gateway endpoint) One or more route table IDs.

setRouteTableIds

public void setRouteTableIds(Collection<String> routeTableIds)

(Gateway endpoint) One or more route table IDs.

Parameters:

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

withRouteTableIds

public CreateVpcEndpointRequest withRouteTableIds(String... routeTableIds)

(Gateway endpoint) One or more 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.

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.

withRouteTableIds

public CreateVpcEndpointRequest withRouteTableIds(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.

getSubnetIds

public List<String> getSubnetIds()

(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

Returns:

(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

setSubnetIds

public void setSubnetIds(Collection<String> subnetIds)

(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

Parameters:

subnetIds - (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

withSubnetIds

public CreateVpcEndpointRequest withSubnetIds(String... subnetIds)

(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

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.

Parameters:

subnetIds - (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

Returns:

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

withSubnetIds

public CreateVpcEndpointRequest withSubnetIds(Collection<String> subnetIds)

(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

Parameters:

subnetIds - (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

Returns:

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

getSecurityGroupIds

public List<String> getSecurityGroupIds()

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

Returns:

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

setSecurityGroupIds

public void setSecurityGroupIds(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.

withSecurityGroupIds

public CreateVpcEndpointRequest withSecurityGroupIds(String... securityGroupIds)

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

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.

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.

withSecurityGroupIds

public CreateVpcEndpointRequest withSecurityGroupIds(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.

setClientToken

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.

Parameters:

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

getClientToken

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.

Returns:

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

withClientToken

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.

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.

setPrivateDnsEnabled

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

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

getPrivateDnsEnabled

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

Returns:

(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

withPrivateDnsEnabled

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

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.

isPrivateDnsEnabled

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

Returns:

(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

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to associate with the endpoint.

Returns:

The tags to associate with the endpoint.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to associate with the endpoint.

Parameters:

tagSpecifications - The tags to associate with the endpoint.

withTagSpecifications

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.

Parameters:

tagSpecifications - The tags to associate with the endpoint.

Returns:

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

withTagSpecifications

public CreateVpcEndpointRequest withTagSpecifications(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.

getDryRunRequest

public Request<CreateVpcEndpointRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateVpcEndpointRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateVpcEndpointRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()