software.amazon.awscdk.services.cloudfront

Class Function

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cloudfront.Function

All Implemented Interfaces:

IConstruct, IDependable, IResource, IFunction

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.597Z")
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 }"))
         .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 and Description
static class	Function.Builder A fluent builder for Function.

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

IFunction.Jsii$Default, IFunction.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Function

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

Function

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

Function

public Function(software.constructs.Construct scope,
                java.lang.String id,
                FunctionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromFunctionAttributes

public static IFunction fromFunctionAttributes(software.constructs.Construct scope,
                                               java.lang.String id,
                                               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

public java.lang.String getFunctionArn()

the ARN of the CloudFront function.

Specified by:

getFunctionArn in interface IFunction

getFunctionName

public java.lang.String getFunctionName()

the name of the CloudFront function.

Specified by:

getFunctionName in interface IFunction

getFunctionStage

public java.lang.String getFunctionStage()

the deployment stage of the CloudFront function.