CfnCloudFrontOriginAccessIdentityPropsMixin
- class aws_cdk.mixins_preview.aws_cloudfront.mixins.CfnCloudFrontOriginAccessIdentityPropsMixin(props, *, strategy=None)
Bases:
MixinThe request to create a new origin access identity (OAI).
An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide .
- See:
- CloudformationResource:
AWS::CloudFront::CloudFrontOriginAccessIdentity
- 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_cloud_front_origin_access_identity_props_mixin = cloudfront_mixins.CfnCloudFrontOriginAccessIdentityPropsMixin(cloudfront_mixins.CfnCloudFrontOriginAccessIdentityMixinProps( cloud_front_origin_access_identity_config=cloudfront_mixins.CfnCloudFrontOriginAccessIdentityPropsMixin.CloudFrontOriginAccessIdentityConfigProperty( comment="comment" ) ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::CloudFront::CloudFrontOriginAccessIdentity.- Parameters:
props (
Union[CfnCloudFrontOriginAccessIdentityMixinProps,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:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['cloudFrontOriginAccessIdentityConfig']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
CloudFrontOriginAccessIdentityConfigProperty
- class CfnCloudFrontOriginAccessIdentityPropsMixin.CloudFrontOriginAccessIdentityConfigProperty(*, comment=None)
Bases:
objectOrigin access identity configuration.
Send a
GETrequest to the/ *CloudFront API version* /CloudFront/identity ID/configresource.- Parameters:
comment (
Optional[str]) – A comment to describe the origin access identity. The comment cannot be longer than 128 characters.- See:
- 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 cloud_front_origin_access_identity_config_property = cloudfront_mixins.CfnCloudFrontOriginAccessIdentityPropsMixin.CloudFrontOriginAccessIdentityConfigProperty( comment="comment" )
Attributes
- comment
A comment to describe the origin access identity.
The comment cannot be longer than 128 characters.