Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

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

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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 is UnauthorizedOperation .

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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
}

Output

Return -> (boolean)

Returns true if the request succeeds; otherwise, it returns an error.