Package software.amazon.awscdk.services.cloudfront

Class Function

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cloudfront.Function

All Implemented Interfaces:

IResource, IFunction, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:03.866Z")
@Stability(Stable)
public class Function
extends Resource
implements IFunction

A CloudFront Function.

Example:

 Bucket s3Bucket;
 // Add a cloudfront Function to a Distribution
 Function cfFunction = Function.Builder.create(this, "Function")
         .code(FunctionCode.fromInline("function handler(event) { return event.request }"))
         .runtime(FunctionRuntime.JS_2_0)
         .build();
 Distribution.Builder.create(this, "distro")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(new S3Origin(s3Bucket))
                 .functionAssociations(List.of(FunctionAssociation.builder()
                         .function(cfFunction)
                         .eventType(FunctionEventType.VIEWER_REQUEST)
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Function.Builder	A fluent builder for Function.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudfront.IFunction

IFunction.Jsii$Default, IFunction.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Function(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Function(software.amazon.jsii.JsiiObjectRef objRef)
	Function(software.constructs.Construct scope, String id, FunctionProps props)

Method Summary

Modifier and Type	Method	Description
static IFunction	fromFunctionAttributes(software.constructs.Construct scope, String id, FunctionAttributes attrs)	Imports a function by its name and ARN.
String	getFunctionArn()	the ARN of the CloudFront function.
String	getFunctionName()	the name of the CloudFront function.
String	getFunctionRuntime()	the runtime of the CloudFront function.
String	getFunctionStage()	the deployment stage of the CloudFront function.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Function

protected Function(software.amazon.jsii.JsiiObjectRef objRef)

Function

protected Function(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Function

@Stability(Stable)
public Function(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 FunctionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromFunctionAttributes

@Stability(Stable)
@NotNull
public static IFunction fromFunctionAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 FunctionAttributes attrs)

Imports a function by its name and ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getFunctionArn

@Stability(Stable)
@NotNull
public String getFunctionArn()

the ARN of the CloudFront function.

Specified by:

getFunctionArn in interface IFunction

getFunctionName

@Stability(Stable)
@NotNull
public String getFunctionName()

the name of the CloudFront function.

Specified by:

getFunctionName in interface IFunction

getFunctionRuntime

@Stability(Stable)
@NotNull
public String getFunctionRuntime()

the runtime of the CloudFront function.

getFunctionStage

@Stability(Stable)
@NotNull
public String getFunctionStage()

the deployment stage of the CloudFront function.