com.amazonaws.services.ec2.model

Class CreateVpcEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateVpcEndpointRequest

All Implemented Interfaces:

DryRunSupportedRequest<CreateVpcEndpointRequest>, java.io.Serializable, java.lang.Cloneable

public class CreateVpcEndpointRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<CreateVpcEndpointRequest>

Container for the parameters to the CreateVpcEndpoint operation.

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

See Also:

AmazonEC2.createVpcEndpoint(CreateVpcEndpointRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateVpcEndpointRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientToken() Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
Request<CreateVpcEndpointRequest>	getDryRunRequest() This method is intended for internal use only.
java.lang.String	getPolicyDocument() A policy to attach to the endpoint that controls access to the service.
java.util.List<java.lang.String>	getRouteTableIds() One or more route table IDs.
java.lang.String	getServiceName() The AWS service name, in the form com.amazonaws.region.service.
java.lang.String	getVpcId() The ID of the VPC in which the endpoint will be used.
int	hashCode()
void	setClientToken(java.lang.String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
void	setPolicyDocument(java.lang.String policyDocument) A policy to attach to the endpoint that controls access to the service.
void	setRouteTableIds(java.util.Collection<java.lang.String> routeTableIds) One or more route table IDs.
void	setServiceName(java.lang.String serviceName) The AWS service name, in the form com.amazonaws.region.service.
void	setVpcId(java.lang.String vpcId) The ID of the VPC in which the endpoint will be used.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateVpcEndpointRequest	withClientToken(java.lang.String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
CreateVpcEndpointRequest	withPolicyDocument(java.lang.String policyDocument) A policy to attach to the endpoint that controls access to the service.
CreateVpcEndpointRequest	withRouteTableIds(java.util.Collection<java.lang.String> routeTableIds) One or more route table IDs.
CreateVpcEndpointRequest	withRouteTableIds(java.lang.String... routeTableIds) One or more route table IDs.
CreateVpcEndpointRequest	withServiceName(java.lang.String serviceName) The AWS service name, in the form com.amazonaws.region.service.
CreateVpcEndpointRequest	withVpcId(java.lang.String vpcId) The ID of the VPC in which the endpoint will be used.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVpcEndpointRequest

public CreateVpcEndpointRequest()

Method Detail

getVpcId

public java.lang.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.

setVpcId

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

withVpcId

public CreateVpcEndpointRequest withVpcId(java.lang.String vpcId)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getServiceName

public java.lang.String getServiceName()

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

Returns:

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

setServiceName

public void setServiceName(java.lang.String serviceName)

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

Parameters:

serviceName - The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

withServiceName

public CreateVpcEndpointRequest withServiceName(java.lang.String serviceName)

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

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

Parameters:

serviceName - The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

Returns:

A reference to this updated object so that method calls can be chained together.

getPolicyDocument

public java.lang.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.

setPolicyDocument

public void setPolicyDocument(java.lang.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.

withPolicyDocument

public CreateVpcEndpointRequest withPolicyDocument(java.lang.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.

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

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:

A reference to this updated object so that method calls can be chained together.

getRouteTableIds

public java.util.List<java.lang.String> getRouteTableIds()

One or more route table IDs.

Returns:

One or more route table IDs.

setRouteTableIds

public void setRouteTableIds(java.util.Collection<java.lang.String> routeTableIds)

One or more route table IDs.

Parameters:

routeTableIds - One or more route table IDs.

withRouteTableIds

public CreateVpcEndpointRequest withRouteTableIds(java.lang.String... routeTableIds)

One or more route table IDs.

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

Parameters:

routeTableIds - One or more route table IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

withRouteTableIds

public CreateVpcEndpointRequest withRouteTableIds(java.util.Collection<java.lang.String> routeTableIds)

One or more route table IDs.

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

Parameters:

routeTableIds - One or more route table IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public java.lang.String getClientToken()

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

Returns:

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

setClientToken

public void setClientToken(java.lang.String clientToken)

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

Parameters:

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

withClientToken

public CreateVpcEndpointRequest withClientToken(java.lang.String clientToken)

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

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

Parameters:

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

Returns:

A reference to this updated 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 java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object