CfnKeyGroupPropsMixin

class aws_cdk.mixins_preview.aws_cloudfront.mixins.CfnKeyGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

A key group.

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html

CloudformationResource:

AWS::CloudFront::KeyGroup

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cloudfront import mixins as cloudfront_mixins

cfn_key_group_props_mixin = cloudfront_mixins.CfnKeyGroupPropsMixin(cloudfront_mixins.CfnKeyGroupMixinProps(
    key_group_config=cloudfront_mixins.CfnKeyGroupPropsMixin.KeyGroupConfigProperty(
        comment="comment",
        items=["items"],
        name="name"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:
  • props (Union[CfnKeyGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['keyGroupConfig']

Static Methods

classmethod is_mixin(x)

(experimental) 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.

Stability:

experimental

KeyGroupConfigProperty

class CfnKeyGroupPropsMixin.KeyGroupConfigProperty(*, comment=None, items=None, name=None)

Bases: object

A key group configuration.

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies .

Parameters:
  • comment (Optional[str]) – A comment to describe the key group. The comment cannot be longer than 128 characters.

  • items (Optional[Sequence[str]]) – A list of the identifiers of the public keys in the key group.

  • name (Optional[str]) – A name to identify the key group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keygroup-keygroupconfig.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.mixins_preview.aws_cloudfront import mixins as cloudfront_mixins

key_group_config_property = cloudfront_mixins.CfnKeyGroupPropsMixin.KeyGroupConfigProperty(
    comment="comment",
    items=["items"],
    name="name"
)

Attributes

comment

A comment to describe the key group.

The comment cannot be longer than 128 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keygroup-keygroupconfig.html#cfn-cloudfront-keygroup-keygroupconfig-comment

items

A list of the identifiers of the public keys in the key group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keygroup-keygroupconfig.html#cfn-cloudfront-keygroup-keygroupconfig-items

name

A name to identify the key group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-keygroup-keygroupconfig.html#cfn-cloudfront-keygroup-keygroupconfig-name