modify-vpc-endpoint¶
Description¶
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 the Amazon Web Services PrivateLink Guide .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
modify-vpc-endpoint
[--dry-run | --no-dry-run]
--vpc-endpoint-id <value>
[--reset-policy | --no-reset-policy]
[--policy-document <value>]
[--add-route-table-ids <value>]
[--remove-route-table-ids <value>]
[--add-subnet-ids <value>]
[--remove-subnet-ids <value>]
[--add-security-group-ids <value>]
[--remove-security-group-ids <value>]
[--ip-address-type <value>]
[--dns-options <value>]
[--private-dns-enabled | --no-private-dns-enabled]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--dry-run | --no-dry-run (boolean)
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.
--vpc-endpoint-id (string)
The ID of the endpoint.
--reset-policy | --no-reset-policy (boolean)
(Gateway endpoint) Specify
trueto reset the policy document to the default policy. The default policy allows full access to the service.
--policy-document (string)
(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.
--add-route-table-ids (list)
(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
(string)
Syntax:
"string" "string" ...
--remove-route-table-ids (list)
(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
(string)
Syntax:
"string" "string" ...
--add-subnet-ids (list)
(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
(string)
Syntax:
"string" "string" ...
--remove-subnet-ids (list)
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
(string)
Syntax:
"string" "string" ...
--add-security-group-ids (list)
(Interface endpoint) One or more security group IDs to associate with the network interface.
(string)
Syntax:
"string" "string" ...
--remove-security-group-ids (list)
(Interface endpoint) One or more security group IDs to disassociate from the network interface.
(string)
Syntax:
"string" "string" ...
--ip-address-type (string)
The IP address type for the endpoint.
Possible values:
ipv4
dualstack
ipv6
--dns-options (structure)
The DNS options for the endpoint.
DnsRecordIpType -> (string)
The DNS records created for the endpoint.
Shorthand Syntax:
DnsRecordIpType=string
JSON Syntax:
{
"DnsRecordIpType": "ipv4"|"dualstack"|"ipv6"|"service-defined"
}
--private-dns-enabled | --no-private-dns-enabled (boolean)
(Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To modify a gateway endpoint
This example modifies gateway endpoint vpce-1a2b3c4d by associating route table rtb-aaa222bb with the endpoint, and resetting the policy document.
Command:
aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-1a2b3c4d --add-route-table-ids rtb-aaa222bb --reset-policy
Output:
{
"Return": true
}
To modify an interface endpoint
This example modifies interface endpoint vpce-0fe5b17a0707d6fa5 by adding subnet subnet-d6fcaa8d to the endpoint.
Command:
aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-0fe5b17a0707d6fa5 --add-subnet-id subnet-d6fcaa8d
Output:
{
"Return": true
}