Function

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

Bases: Resource

A CloudFront Function.

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

Example:

# s3_bucket: s3.Bucket
# Add a cloudfront Function to a Distribution
cf_function = cloudfront.Function(self, "Function",
    code=cloudfront.FunctionCode.from_inline("function handler(event) { return event.request }")
)
cloudfront.Distribution(self, "distro",
    default_behavior=cloudfront.BehaviorOptions(
        origin=origins.S3Origin(s3_bucket),
        function_associations=[cloudfront.FunctionAssociation(
            function=cf_function,
            event_type=cloudfront.FunctionEventType.VIEWER_REQUEST
        )]
    )
)

Parameters:

scope (Construct) –
id (str) –
code (FunctionCode) – The source code of the function.
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

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

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_stage

the deployment stage of the CloudFront function.

Attribute:: true

node: The construct tree node associated with this construct.

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

Static Methods

classmethod from_function_attributes(scope, id, *, function_arn, function_name)

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.

Return type:

IFunction

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool