aws-cdk-lib.aws_cloudfront.IFunction

interface IFunction

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.IFunction
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#IFunction
Javasoftware.amazon.awscdk.services.cloudfront.IFunction
Pythonaws_cdk.aws_cloudfront.IFunction
TypeScript (source)aws-cdk-lib » aws_cloudfront » IFunction

Implemented by Function

Obtainable from Function.fromFunctionAttributes()

Represents a CloudFront Function.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
functionArnstringThe ARN of the function.
functionNamestringThe name of the function.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

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.


functionArn

Type: string

The ARN of the function.


functionName

Type: string

The name of the function.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).