class CfnFunctionPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CloudFront.Mixins.CfnFunctionPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscloudfront/mixins#CfnFunctionPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.cloudfront.mixins.CfnFunctionPropsMixin
Python	aws_cdk.mixins_preview.aws_cloudfront.mixins.CfnFunctionPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_cloudfront » mixins » CfnFunctionPropsMixin

Implements IMixin

Extends Mixin

Creates a CloudFront function.

To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage.

By default, when you create a function, it’s in the DEVELOPMENT stage. In this stage, you can test the function in the CloudFront console (or with TestFunction in the CloudFront API).

When you’re ready to use your function with a CloudFront distribution, publish the function to the LIVE stage. You can do this in the CloudFront console, with PublishFunction in the CloudFront API, or by updating the AWS::CloudFront::Function resource with the AutoPublish property set to true . When the function is published to the LIVE stage, you can attach it to a distribution’s cache behavior, using the function’s ARN.

To automatically publish the function to the LIVE stage when it’s created, set the AutoPublish property to true .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as cloudfront_mixins } from '@aws-cdk/mixins-preview/aws-cloudfront';
const cfnFunctionPropsMixin = new cloudfront_mixins.CfnFunctionPropsMixin({
  autoPublish: false,
  functionCode: 'functionCode',
  functionConfig: {
    comment: 'comment',
    keyValueStoreAssociations: [{
      keyValueStoreArn: 'keyValueStoreArn',
    }],
    runtime: 'runtime',
  },
  functionMetadata: {
    functionArn: 'functionArn',
  },
  name: 'name',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnFunctionPropsMixin(props: CfnFunctionMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnFunctionMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnFunctionMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnFunctionMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.