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-encryption-control

Description

Modifies the encryption control configuration for a VPC. You can update the encryption mode and exclusion settings for various gateway types and peering connections.

For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide .

See also: AWS API Documentation

Synopsis

  modify-vpc-encryption-control
[--dry-run | --no-dry-run]
--vpc-encryption-control-id <value>
[--mode <value>]
[--internet-gateway-exclusion <value>]
[--egress-only-internet-gateway-exclusion <value>]
[--nat-gateway-exclusion <value>]
[--virtual-private-gateway-exclusion <value>]
[--vpc-peering-exclusion <value>]
[--lambda-exclusion <value>]
[--vpc-lattice-exclusion <value>]
[--elastic-file-system-exclusion <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 .

--vpc-encryption-control-id (string)

The ID of the VPC Encryption Control resource to modify.

--mode (string)

The encryption mode for the VPC Encryption Control configuration.

Possible values:

• monitor
• enforce

--internet-gateway-exclusion (string)

Specifies whether to exclude internet gateway traffic from encryption enforcement.

Possible values:

• enable
• disable

--egress-only-internet-gateway-exclusion (string)

Specifies whether to exclude egress-only internet gateway traffic from encryption enforcement.

Possible values:

• enable
• disable

--nat-gateway-exclusion (string)

Specifies whether to exclude NAT gateway traffic from encryption enforcement.

Possible values:

• enable
• disable

--virtual-private-gateway-exclusion (string)

Specifies whether to exclude virtual private gateway traffic from encryption enforcement.

Possible values:

• enable
• disable

--vpc-peering-exclusion (string)

Specifies whether to exclude VPC peering connection traffic from encryption enforcement.

Possible values:

• enable
• disable

--lambda-exclusion (string)

Specifies whether to exclude Lambda function traffic from encryption enforcement.

Possible values:

• enable
• disable

--vpc-lattice-exclusion (string)

Specifies whether to exclude VPC Lattice traffic from encryption enforcement.

Possible values:

• enable
• disable

--elastic-file-system-exclusion (string)

Specifies whether to exclude Elastic File System traffic from encryption enforcement.

Possible values:

• enable
• disable

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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.

Output

VpcEncryptionControl -> (structure)

Information about the VPC Encryption Control configuration.

VpcId -> (string)

The ID of the VPC associated with the encryption control configuration.

VpcEncryptionControlId -> (string)

The ID of the VPC Encryption Control configuration.

Mode -> (string)

The encryption mode for the VPC Encryption Control configuration.

State -> (string)

The current state of the VPC Encryption Control configuration.

StateMessage -> (string)

A message providing additional information about the encryption control state.

ResourceExclusions -> (structure)

Information about resource exclusions for the VPC Encryption Control configuration.

InternetGateway -> (structure)

The exclusion configuration for internet gateway traffic.

State -> (string)

The current state of the exclusion configuration.

StateMessage -> (string)

A message providing additional information about the exclusion state.

EgressOnlyInternetGateway -> (structure)

The exclusion configuration for egress-only internet gateway traffic.

State -> (string)

The current state of the exclusion configuration.

StateMessage -> (string)

A message providing additional information about the exclusion state.

NatGateway -> (structure)

The exclusion configuration for NAT gateway traffic.

State -> (string)

The current state of the exclusion configuration.

StateMessage -> (string)

A message providing additional information about the exclusion state.

VirtualPrivateGateway -> (structure)

The exclusion configuration for virtual private gateway traffic.

State -> (string)

The current state of the exclusion configuration.

StateMessage -> (string)

A message providing additional information about the exclusion state.

VpcPeering -> (structure)

The exclusion configuration for VPC peering connection traffic.

State -> (string)

The current state of the exclusion configuration.

StateMessage -> (string)

A message providing additional information about the exclusion state.

Lambda -> (structure)

The exclusion configuration for Lambda function traffic.

State -> (string)

The current state of the exclusion configuration.

StateMessage -> (string)

A message providing additional information about the exclusion state.

VpcLattice -> (structure)

The exclusion configuration for VPC Lattice traffic.

State -> (string)

The current state of the exclusion configuration.

StateMessage -> (string)

A message providing additional information about the exclusion state.

ElasticFileSystem -> (structure)

The exclusion configuration for Elastic File System traffic.

State -> (string)

The current state of the exclusion configuration.

StateMessage -> (string)

A message providing additional information about the exclusion state.

Tags -> (list)

The tags assigned to the VPC Encryption Control configuration.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.