CfnVPCEncryptionControl

class aws_cdk.aws_ec2.CfnVPCEncryptionControl(scope, id, *, egress_only_internet_gateway_exclusion_input=None, elastic_file_system_exclusion_input=None, internet_gateway_exclusion_input=None, lambda_exclusion_input=None, mode=None, nat_gateway_exclusion_input=None, tags=None, virtual_private_gateway_exclusion_input=None, vpc_id=None, vpc_lattice_exclusion_input=None, vpc_peering_exclusion_input=None)

Bases: CfnResource

Describes the configuration and state of VPC encryption controls.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpcencryptioncontrol.html

CloudformationResource:

AWS::EC2::VPCEncryptionControl

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

cfn_vPCEncryption_control = ec2.CfnVPCEncryptionControl(self, "MyCfnVPCEncryptionControl",
    egress_only_internet_gateway_exclusion_input="egressOnlyInternetGatewayExclusionInput",
    elastic_file_system_exclusion_input="elasticFileSystemExclusionInput",
    internet_gateway_exclusion_input="internetGatewayExclusionInput",
    lambda_exclusion_input="lambdaExclusionInput",
    mode="mode",
    nat_gateway_exclusion_input="natGatewayExclusionInput",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    virtual_private_gateway_exclusion_input="virtualPrivateGatewayExclusionInput",
    vpc_id="vpcId",
    vpc_lattice_exclusion_input="vpcLatticeExclusionInput",
    vpc_peering_exclusion_input="vpcPeeringExclusionInput"
)

Create a new AWS::EC2::VPCEncryptionControl.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • egress_only_internet_gateway_exclusion_input (Optional[str]) – Specifies whether to exclude egress-only internet gateway traffic from encryption enforcement.

  • elastic_file_system_exclusion_input (Optional[str]) – Specifies whether to exclude Elastic File System traffic from encryption enforcement.

  • internet_gateway_exclusion_input (Optional[str]) – Specifies whether to exclude internet gateway traffic from encryption enforcement.

  • lambda_exclusion_input (Optional[str]) – Specifies whether to exclude Lambda function traffic from encryption enforcement.

  • mode (Optional[str]) – The encryption mode for the VPC Encryption Control configuration.

  • nat_gateway_exclusion_input (Optional[str]) – Specifies whether to exclude NAT gateway traffic from encryption enforcement.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags assigned to the VPC Encryption Control configuration.

  • virtual_private_gateway_exclusion_input (Optional[str]) – Specifies whether to exclude virtual private gateway traffic from encryption enforcement.

  • vpc_id (Optional[str]) – The ID of the VPC for which to create the encryption control configuration.

  • vpc_lattice_exclusion_input (Optional[str]) – Specifies whether to exclude VPC Lattice traffic from encryption enforcement.

  • vpc_peering_exclusion_input (Optional[str]) – Specifies whether to exclude VPC peering connection traffic from encryption enforcement.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::EC2::VPCEncryptionControl'
attr_resource_exclusions

ResourceExclusions

Type:

cloudformationAttribute

attr_resource_exclusions_egress_only_internet_gateway

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

CloudformationAttribute:

ResourceExclusions.EgressOnlyInternetGateway

attr_resource_exclusions_egress_only_internet_gateway_state

The current state of the exclusion configuration.

CloudformationAttribute:

ResourceExclusions.EgressOnlyInternetGateway.State

attr_resource_exclusions_egress_only_internet_gateway_state_message

A message providing additional information about the exclusion state.

CloudformationAttribute:

ResourceExclusions.EgressOnlyInternetGateway.StateMessage

attr_resource_exclusions_elastic_file_system

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

CloudformationAttribute:

ResourceExclusions.ElasticFileSystem

attr_resource_exclusions_elastic_file_system_state

The current state of the exclusion configuration.

CloudformationAttribute:

ResourceExclusions.ElasticFileSystem.State

attr_resource_exclusions_elastic_file_system_state_message

A message providing additional information about the exclusion state.

CloudformationAttribute:

ResourceExclusions.ElasticFileSystem.StateMessage

attr_resource_exclusions_internet_gateway

Specifies whether to exclude internet gateway traffic from encryption enforcement.

CloudformationAttribute:

ResourceExclusions.InternetGateway

attr_resource_exclusions_internet_gateway_state

The current state of the exclusion configuration.

CloudformationAttribute:

ResourceExclusions.InternetGateway.State

attr_resource_exclusions_internet_gateway_state_message

A message providing additional information about the exclusion state.

CloudformationAttribute:

ResourceExclusions.InternetGateway.StateMessage

attr_resource_exclusions_lambda

Specifies whether to exclude Lambda function traffic from encryption enforcement.

CloudformationAttribute:

ResourceExclusions.Lambda

attr_resource_exclusions_lambda_state

The current state of the exclusion configuration.

CloudformationAttribute:

ResourceExclusions.Lambda.State

attr_resource_exclusions_lambda_state_message

A message providing additional information about the exclusion state.

CloudformationAttribute:

ResourceExclusions.Lambda.StateMessage

attr_resource_exclusions_nat_gateway

Specifies whether to exclude NAT gateway traffic from encryption enforcement.

CloudformationAttribute:

ResourceExclusions.NatGateway

attr_resource_exclusions_nat_gateway_state

The current state of the exclusion configuration.

CloudformationAttribute:

ResourceExclusions.NatGateway.State

attr_resource_exclusions_nat_gateway_state_message

A message providing additional information about the exclusion state.

CloudformationAttribute:

ResourceExclusions.NatGateway.StateMessage

attr_resource_exclusions_virtual_private_gateway

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

CloudformationAttribute:

ResourceExclusions.VirtualPrivateGateway

attr_resource_exclusions_virtual_private_gateway_state

The current state of the exclusion configuration.

CloudformationAttribute:

ResourceExclusions.VirtualPrivateGateway.State

attr_resource_exclusions_virtual_private_gateway_state_message

A message providing additional information about the exclusion state.

CloudformationAttribute:

ResourceExclusions.VirtualPrivateGateway.StateMessage

attr_resource_exclusions_vpc_lattice

Specifies whether to exclude VPC Lattice traffic from encryption enforcement.

CloudformationAttribute:

ResourceExclusions.VpcLattice

attr_resource_exclusions_vpc_lattice_state

The current state of the exclusion configuration.

CloudformationAttribute:

ResourceExclusions.VpcLattice.State

attr_resource_exclusions_vpc_lattice_state_message

A message providing additional information about the exclusion state.

CloudformationAttribute:

ResourceExclusions.VpcLattice.StateMessage

attr_resource_exclusions_vpc_peering

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

CloudformationAttribute:

ResourceExclusions.VpcPeering

attr_resource_exclusions_vpc_peering_state

The current state of the exclusion configuration.

CloudformationAttribute:

ResourceExclusions.VpcPeering.State

attr_resource_exclusions_vpc_peering_state_message

A message providing additional information about the exclusion state.

CloudformationAttribute:

ResourceExclusions.VpcPeering.StateMessage

attr_state

The current state of the VPC Encryption Control configuration.

CloudformationAttribute:

State

attr_state_message

A message providing additional information about the encryption control state.

CloudformationAttribute:

StateMessage

attr_vpc_encryption_control_id

The ID of the VPC Encryption Control configuration.

CloudformationAttribute:

VpcEncryptionControlId

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

egress_only_internet_gateway_exclusion_input

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

elastic_file_system_exclusion_input

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

env
internet_gateway_exclusion_input

Specifies whether to exclude internet gateway traffic from encryption enforcement.

lambda_exclusion_input

Specifies whether to exclude Lambda function traffic from encryption enforcement.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

mode

The encryption mode for the VPC Encryption Control configuration.

nat_gateway_exclusion_input

Specifies whether to exclude NAT gateway traffic from encryption enforcement.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

The tags assigned to the VPC Encryption Control configuration.

virtual_private_gateway_exclusion_input

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

vpc_encryption_control_ref

A reference to a VPCEncryptionControl resource.

vpc_id

The ID of the VPC for which to create the encryption control configuration.

vpc_lattice_exclusion_input

Specifies whether to exclude VPC Lattice traffic from encryption enforcement.

vpc_peering_exclusion_input

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

Static Methods

classmethod arn_for_vpc_encryption_control(resource)
Parameters:

resource (IVPCEncryptionControlRef)

Return type:

str

classmethod from_vpc_encryption_control_id(scope, id, vpc_encryption_control_id)

Creates a new IVPCEncryptionControlRef from a vpcEncryptionControlId.

Parameters:

  • scope (Construct)

  • id (str)

  • vpc_encryption_control_id (str)

Return type:

IVPCEncryptionControlRef

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_vpc_encryption_control(x)

Checks whether the given object is a CfnVPCEncryptionControl.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ResourceExclusionsProperty

class CfnVPCEncryptionControl.ResourceExclusionsProperty(*, egress_only_internet_gateway=None, elastic_file_system=None, internet_gateway=None, lambda_=None, nat_gateway=None, virtual_private_gateway=None, vpc_lattice=None, vpc_peering=None)

Bases: object

Information about resource exclusions for the VPC Encryption Control configuration.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

resource_exclusions_property = ec2.CfnVPCEncryptionControl.ResourceExclusionsProperty(
    egress_only_internet_gateway=ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
        state="state",
        state_message="stateMessage"
    ),
    elastic_file_system=ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
        state="state",
        state_message="stateMessage"
    ),
    internet_gateway=ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
        state="state",
        state_message="stateMessage"
    ),
    lambda_=ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
        state="state",
        state_message="stateMessage"
    ),
    nat_gateway=ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
        state="state",
        state_message="stateMessage"
    ),
    virtual_private_gateway=ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
        state="state",
        state_message="stateMessage"
    ),
    vpc_lattice=ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
        state="state",
        state_message="stateMessage"
    ),
    vpc_peering=ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
        state="state",
        state_message="stateMessage"
    )
)

Attributes

egress_only_internet_gateway

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-egressonlyinternetgateway

elastic_file_system

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-elasticfilesystem

internet_gateway

Specifies whether to exclude internet gateway traffic from encryption enforcement.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-internetgateway

lambda_

Specifies whether to exclude Lambda function traffic from encryption enforcement.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-lambda

nat_gateway

Specifies whether to exclude NAT gateway traffic from encryption enforcement.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-natgateway

virtual_private_gateway

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-virtualprivategateway

vpc_lattice

Specifies whether to exclude VPC Lattice traffic from encryption enforcement.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-vpclattice

vpc_peering

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-resourceexclusions.html#cfn-ec2-vpcencryptioncontrol-resourceexclusions-vpcpeering

VpcEncryptionControlExclusionProperty

class CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(*, state=None, state_message=None)

Bases: object

Describes an exclusion configuration for VPC Encryption Control.

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

Parameters:

  • state (Optional[str]) – The current state of the exclusion configuration.

  • state_message (Optional[str]) – A message providing additional information about the exclusion state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

vpc_encryption_control_exclusion_property = ec2.CfnVPCEncryptionControl.VpcEncryptionControlExclusionProperty(
    state="state",
    state_message="stateMessage"
)

Attributes

state

The current state of the exclusion configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html#cfn-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion-state

state_message

A message providing additional information about the exclusion state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion.html#cfn-ec2-vpcencryptioncontrol-vpcencryptioncontrolexclusion-statemessage