software.amazon.awscdk.services.cloudfront

Class Function

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cloudfront.Function

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-11T17:58:48.803Z")
 @Stability(value=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 }"))
         .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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	Function(software.constructs.Construct scope, String id, FunctionProps props)
protected	Function(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Function(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and 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	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 software.constructs.Construct

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.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Function

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

Function

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

Function

@Stability(value=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 Detail

fromFunctionAttributes

@Stability(value=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(value=Stable)
 @NotNull
public String getFunctionArn()

the ARN of the CloudFront function.

Specified by:

getFunctionArn in interface IFunction

getFunctionName

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

the name of the CloudFront function.

Specified by:

getFunctionName in interface IFunction

getFunctionStage

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

the deployment stage of the CloudFront function.