ModifyVpcEndpoint
Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see theAWS PrivateLink Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, seeCommon Query Parameters.
- AddRouteTableId.N
(Gateway endpoint) The IDs of the route tables to associate with the endpoint.
Type: Array of strings
Required: No
- AddSecurityGroupId.N
(Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces.
Type: Array of strings
Required: No
- AddSubnetId.N
(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
Type: Array of strings
Required: No
- DnsOptions
The DNS options for the endpoint.
Type:DnsOptionsSpecification object
Required: No
- 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.Type: Boolean
Required: No
- IpAddressType
The IP address type for the endpoint.
Type: String
Valid Values:
ipv4 | dualstack | ipv6Required: No
- 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.
Type: String
Required: No
- PrivateDnsEnabled
(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
Type: Boolean
Required: No
- RemoveRouteTableId.N
(Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.
Type: Array of strings
Required: No
- RemoveSecurityGroupId.N
(Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces.
Type: Array of strings
Required: No
- RemoveSubnetId.N
(Interface endpoint) The IDs of the subnets from which to remove the endpoint.
Type: Array of strings
Required: No
- ResetPolicy
(Gateway endpoint) Specify
trueto reset the policy document to the default policy. The default policy allows full access to the service.Type: Boolean
Required: No
- SubnetConfiguration.N
The subnet configurations for the endpoint.
Type: Array ofSubnetConfiguration objects
Required: No
- VpcEndpointId
The ID of the endpoint.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
The ID of the request.
Type: String
- return
Returns
trueif the request succeeds; otherwise, it returns an error.Type: Boolean
Errors
For information about the errors that are common to all actions, seeCommon client error codes.
Examples
Example 1
This example modifies gateway endpointvpce-1a2b3c4d by associating route tablertb-aaa222bb with the endpoint, and resetting the policy document.
Sample Request
https://ec2.amazonaws.com/?Action=ModifyVpcEndpoint&VpcEndpointId=vpce-1a2b3c4d&ResetPolicy=true&AddRouteTableId.1=rtb-aaa222bb&AUTHPARAMSSample Response
<ModifyVpcEndpointResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <return>true</return> <requestId>125acea6-ba5c-4c6e-8e17-example</requestId></ModifyVpcEndpointResponse>Example 2
This example modifies interface endpointvpce-0fe5b17a0707d6fa5 by adding subnetsubnet-d6fcaa8d to the endpoint.
Sample Request
https://ec2.amazonaws.com/?Action=ModifyVpcEndpoint&VpcEndpointId=vpce-0fe5b17a0707d6fa5&AddSubnetId.1=subnet-d6fcaa8db&AUTHPARAMSSee Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
