EC2 / Client / create_vpc_encryption_control

create_vpc_encryption_control¶

EC2.Client.create_vpc_encryption_control(**kwargs)¶

Creates a VPC Encryption Control configuration for a specified VPC. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements for standards like HIPAA, FedRAMP, and PCI DSS.

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

Request Syntax

response = client.create_vpc_encryption_control(
    DryRun=True|False,
    VpcId='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'capacity-manager-data-export'|'vpn-concentrator',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

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

The ID of the VPC for which to create the encryption control configuration.
TagSpecifications (list) –
The tags to apply to the VPC Encryption Control resource.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (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.

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.