Function

class aws_cdk.aws_cloudfront.Function(scope, id, *, code, auto_publish=None, comment=None, function_name=None, key_value_store=None, runtime=None)

Bases: Resource

A CloudFront Function.

Resource:: AWS::CloudFront::Function
ExampleMetadata:: infused

Example:

store = cloudfront.KeyValueStore(self, "KeyValueStore")
cloudfront.Function(self, "Function",
    code=cloudfront.FunctionCode.from_inline("function handler(event) { return event.request }"),
    # Note that JS_2_0 must be used for Key Value Store support
    runtime=cloudfront.FunctionRuntime.JS_2_0,
    key_value_store=store
)

Parameters:

scope (Construct)
id (str)
code (FunctionCode) – The source code of the function.
auto_publish (Optional[bool]) – A flag that determines whether to automatically publish the function to the LIVE stage when it’s created. Default: - true
comment (Optional[str]) – A comment to describe the function. Default: - same as functionName
function_name (Optional[str]) – A name to identify the function. Default: - generated from the id
key_value_store (Optional[IKeyValueStoreRef]) – The Key Value Store to associate with this function. In order to associate a Key Value Store, the runtime must be cloudfront-js-2.0 or newer. Default: - no key value store is associated
runtime (Optional[FunctionRuntime]) – The runtime environment for the function. Default: FunctionRuntime.JS_1_0 (unless keyValueStore is specified, then FunctionRuntime.JS_2_0)

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-cloudfront.Function'

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

function_arn

the ARN of the CloudFront function.

Attribute:: true

function_name

the name of the CloudFront function.

Attribute:: true

function_ref: A reference to a Function resource.

function_runtime

the runtime of the CloudFront function.

Attribute:: true

function_stage

the deployment stage of the CloudFront function.

Attribute:: true

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_function_attributes(scope, id, *, function_arn, function_name, function_runtime=None)

Imports a function by its name and ARN.

Parameters:

scope (Construct)
id (str)
function_arn (str) – The ARN of the function.
function_name (str) – The name of the function.
function_runtime (Optional[str]) – The Runtime of the function. Default: FunctionRuntime.JS_1_0

Return type:

IFunction

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

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

classmethod is_resource(construct)

Check whether the given construct is a Resource.

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