EC2 / Client / modify_vpc_encryption_control

modify_vpc_encryption_control¶

EC2.Client.modify_vpc_encryption_control(**kwargs)¶

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.

Request Syntax

response = client.modify_vpc_encryption_control(
    DryRun=True|False,
    VpcEncryptionControlId='string',
    Mode='monitor'|'enforce',
    InternetGatewayExclusion='enable'|'disable',
    EgressOnlyInternetGatewayExclusion='enable'|'disable',
    NatGatewayExclusion='enable'|'disable',
    VirtualPrivateGatewayExclusion='enable'|'disable',
    VpcPeeringExclusion='enable'|'disable',
    LambdaExclusion='enable'|'disable',
    VpcLatticeExclusion='enable'|'disable',
    ElasticFileSystemExclusion='enable'|'disable'
)

Parameters:

DryRun (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.
VpcEncryptionControlId (string) –
[REQUIRED]

The ID of the VPC Encryption Control resource to modify.
Mode (string) – The encryption mode for the VPC Encryption Control configuration.
InternetGatewayExclusion (string) – Specifies whether to exclude internet gateway traffic from encryption enforcement.
EgressOnlyInternetGatewayExclusion (string) – Specifies whether to exclude egress-only internet gateway traffic from encryption enforcement.
NatGatewayExclusion (string) – Specifies whether to exclude NAT gateway traffic from encryption enforcement.
VirtualPrivateGatewayExclusion (string) – Specifies whether to exclude virtual private gateway traffic from encryption enforcement.
VpcPeeringExclusion (string) – Specifies whether to exclude VPC peering connection traffic from encryption enforcement.
LambdaExclusion (string) – Specifies whether to exclude Lambda function traffic from encryption enforcement.
VpcLatticeExclusion (string) – Specifies whether to exclude VPC Lattice traffic from encryption enforcement.
ElasticFileSystemExclusion (string) – Specifies whether to exclude Elastic File System traffic from encryption enforcement.

Return type:

dict

Returns:

Response Syntax

{
    'VpcEncryptionControl': {
        'VpcId': 'string',
        'VpcEncryptionControlId': 'string',
        'Mode': 'monitor'|'enforce',
        'State': 'enforce-in-progress'|'monitor-in-progress'|'enforce-failed'|'monitor-failed'|'deleting'|'deleted'|'available'|'creating'|'delete-failed',
        'StateMessage': 'string',
        'ResourceExclusions': {
            'InternetGateway': {
                'State': 'enabling'|'enabled'|'disabling'|'disabled',
                'StateMessage': 'string'
            },
            'EgressOnlyInternetGateway': {
                'State': 'enabling'|'enabled'|'disabling'|'disabled',
                'StateMessage': 'string'
            },
            'NatGateway': {
                'State': 'enabling'|'enabled'|'disabling'|'disabled',
                'StateMessage': 'string'
            },
            'VirtualPrivateGateway': {
                'State': 'enabling'|'enabled'|'disabling'|'disabled',
                'StateMessage': 'string'
            },
            'VpcPeering': {
                'State': 'enabling'|'enabled'|'disabling'|'disabled',
                'StateMessage': 'string'
            },
            'Lambda': {
                'State': 'enabling'|'enabled'|'disabling'|'disabled',
                'StateMessage': 'string'
            },
            'VpcLattice': {
                'State': 'enabling'|'enabled'|'disabling'|'disabled',
                'StateMessage': 'string'
            },
            'ElasticFileSystem': {
                'State': 'enabling'|'enabled'|'disabling'|'disabled',
                'StateMessage': 'string'
            }
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- VpcEncryptionControl (dict) –
  
  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 (dict) –
    
    Information about resource exclusions for the VPC Encryption Control configuration.
    - InternetGateway (dict) –
      
      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 (dict) –
      
      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 (dict) –
      
      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 (dict) –
      
      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 (dict) –
      
      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 (dict) –
      
      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 (dict) –
      
      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 (dict) –
      
      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.
    - (dict) –
      
      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.