CfnFieldLevelEncryptionProfilePropsMixin

class aws_cdk.cfn_property_mixins.aws_cloudfront.CfnFieldLevelEncryptionProfilePropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::CloudFront::FieldLevelEncryptionProfile.

A field-level encryption profile maps CloudFront public keys and provider identities to the request-body field patterns that CloudFront encrypts with them.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-fieldlevelencryptionprofile.html
CloudformationResource:: AWS::CloudFront::FieldLevelEncryptionProfile
Mixin:: true
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.cfn_property_mixins import aws_cloudfront as cloudfront
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_field_level_encryption_profile_props_mixin = cloudfront.CfnFieldLevelEncryptionProfilePropsMixin(cloudfront.CfnFieldLevelEncryptionProfileMixinProps(
    field_level_encryption_profile_config=cloudfront.CfnFieldLevelEncryptionProfilePropsMixin.FieldLevelEncryptionProfileConfigProperty(
        caller_reference="callerReference",
        comment="comment",
        encryption_entities=[cloudfront.CfnFieldLevelEncryptionProfilePropsMixin.EncryptionEntityProperty(
            field_patterns=["fieldPatterns"],
            provider_id="providerId",
            public_key_id="publicKeyId"
        )],
        name="name"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::CloudFront::FieldLevelEncryptionProfile.

Parameters:

props (Union[CfnFieldLevelEncryptionProfileMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['fieldLevelEncryptionProfileConfig']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

EncryptionEntityProperty

class CfnFieldLevelEncryptionProfilePropsMixin.EncryptionEntityProperty(*, field_patterns=None, provider_id=None, public_key_id=None)

Bases: object

A public key, its provider identity, and the field patterns CloudFront encrypts with that key.

Parameters:

field_patterns (Optional[Sequence[str]]) – The request-body field names to encrypt. A pattern is either a full field name or leading characters followed by a wildcard (*). Patterns are case-sensitive and must not overlap.
provider_id (Optional[str]) – The provider associated with the public key. The same value must be supplied with the private key for an application to decrypt the data.
public_key_id (Optional[str]) – The identifier of the CloudFront public key used to encrypt the fields that match the patterns.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-fieldlevelencryptionprofile-encryptionentity.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.cfn_property_mixins import aws_cloudfront as cloudfront

encryption_entity_property = cloudfront.CfnFieldLevelEncryptionProfilePropsMixin.EncryptionEntityProperty(
    field_patterns=["fieldPatterns"],
    provider_id="providerId",
    public_key_id="publicKeyId"
)

Attributes

field_patterns

The request-body field names to encrypt.

A pattern is either a full field name or leading characters followed by a wildcard (*). Patterns are case-sensitive and must not overlap.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-fieldlevelencryptionprofile-encryptionentity.html#cfn-cloudfront-fieldlevelencryptionprofile-encryptionentity-fieldpatterns

provider_id

The provider associated with the public key.

The same value must be supplied with the private key for an application to decrypt the data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-fieldlevelencryptionprofile-encryptionentity.html#cfn-cloudfront-fieldlevelencryptionprofile-encryptionentity-providerid

public_key_id

The identifier of the CloudFront public key used to encrypt the fields that match the patterns.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-fieldlevelencryptionprofile-encryptionentity.html#cfn-cloudfront-fieldlevelencryptionprofile-encryptionentity-publickeyid

FieldLevelEncryptionProfileConfigProperty

class CfnFieldLevelEncryptionProfilePropsMixin.FieldLevelEncryptionProfileConfigProperty(*, caller_reference=None, comment=None, encryption_entities=None, name=None)

Bases: object

The configuration of a field-level encryption profile.

Parameters:

caller_reference (Optional[str]) – A unique value that identifies the creation request. Caller references are unique within an AWS account and cannot be changed after creation.
comment (Optional[str]) – An optional comment describing the field-level encryption profile.
encryption_entities (Union[IResolvable, Sequence[Union[IResolvable, EncryptionEntityProperty, Dict[str, Any]]], None]) – The encryption entities of the field-level encryption profile. At least one entity is required.
name (Optional[str]) – The name of the field-level encryption profile. Names are unique within an AWS account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-fieldlevelencryptionprofile-fieldlevelencryptionprofileconfig.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.cfn_property_mixins import aws_cloudfront as cloudfront

field_level_encryption_profile_config_property = cloudfront.CfnFieldLevelEncryptionProfilePropsMixin.FieldLevelEncryptionProfileConfigProperty(
    caller_reference="callerReference",
    comment="comment",
    encryption_entities=[cloudfront.CfnFieldLevelEncryptionProfilePropsMixin.EncryptionEntityProperty(
        field_patterns=["fieldPatterns"],
        provider_id="providerId",
        public_key_id="publicKeyId"
    )],
    name="name"
)