CfnFunctionMixinProps
- class aws_cdk.mixins_preview.aws_cloudfront.mixins.CfnFunctionMixinProps(*, auto_publish=None, function_code=None, function_config=None, function_metadata=None, name=None)
Bases:
objectProperties for CfnFunctionPropsMixin.
- Parameters:
auto_publish (
Union[bool,IResolvable,None]) – A flag that determines whether to automatically publish the function to theLIVEstage when it’s created. To automatically publish to theLIVEstage, set this property totrue.function_code (
Optional[str]) – The function code. For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide .function_config (
Union[IResolvable,FunctionConfigProperty,Dict[str,Any],None]) – Contains configuration information about a CloudFront function.function_metadata (
Union[IResolvable,FunctionMetadataProperty,Dict[str,Any],None]) – Contains metadata about a CloudFront function.name (
Optional[str]) – A name to identify the function.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.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 cfn_function_mixin_props = cloudfront_mixins.CfnFunctionMixinProps( auto_publish=False, function_code="functionCode", function_config=cloudfront_mixins.CfnFunctionPropsMixin.FunctionConfigProperty( comment="comment", key_value_store_associations=[cloudfront_mixins.CfnFunctionPropsMixin.KeyValueStoreAssociationProperty( key_value_store_arn="keyValueStoreArn" )], runtime="runtime" ), function_metadata=cloudfront_mixins.CfnFunctionPropsMixin.FunctionMetadataProperty( function_arn="functionArn" ), name="name" )
Attributes
- auto_publish
A flag that determines whether to automatically publish the function to the
LIVEstage when it’s created.To automatically publish to the
LIVEstage, set this property totrue.
- function_code
The function code.
For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide .
- function_config
Contains configuration information about a CloudFront function.
- function_metadata
Contains metadata about a CloudFront function.
- name
A name to identify the function.