modify-vpc-endpoint-service-configuration¶
Description¶
Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.
If you set or modify the private DNS name, you must prove that you own the private DNS domain name.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
modify-vpc-endpoint-service-configuration
[--dry-run | --no-dry-run]
--service-id <value>
[--private-dns-name <value>]
[--remove-private-dns-name | --no-remove-private-dns-name]
[--acceptance-required | --no-acceptance-required]
[--add-network-load-balancer-arns <value>]
[--remove-network-load-balancer-arns <value>]
[--add-gateway-load-balancer-arns <value>]
[--remove-gateway-load-balancer-arns <value>]
[--add-supported-ip-address-types <value>]
[--remove-supported-ip-address-types <value>]
[--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.
--service-id (string)
The ID of the service.
--private-dns-name (string)
(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
--remove-private-dns-name | --no-remove-private-dns-name (boolean)
(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
--acceptance-required | --no-acceptance-required (boolean)
Indicates whether requests to create an endpoint to your service must be accepted.
--add-network-load-balancer-arns (list)
The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
(string)
Syntax:
"string" "string" ...
--remove-network-load-balancer-arns (list)
The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
(string)
Syntax:
"string" "string" ...
--add-gateway-load-balancer-arns (list)
The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
(string)
Syntax:
"string" "string" ...
--remove-gateway-load-balancer-arns (list)
The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
(string)
Syntax:
"string" "string" ...
--add-supported-ip-address-types (list)
The IP address types to add to your service configuration.
(string)
Syntax:
"string" "string" ...
--remove-supported-ip-address-types (list)
The IP address types to remove from your service configuration.
(string)
Syntax:
"string" "string" ...
--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 an endpoint service configuration
This example changes the acceptance requirement for the specified endpoint service.
Command:
aws ec2 modify-vpc-endpoint-service-configuration --service-id vpce-svc-09222513e6e77dc86 --no-acceptance-required
Output:
{
"ReturnValue": true
}