Package software.amazon.awscdk.services.cloudfront

Class CfnFunction

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudfront.CfnFunction
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.569Z") @Stability(Stable) public class CfnFunction extends CfnResource implements IInspectable
A CloudFormation AWS::CloudFront::Function.

Creates a CloudFront function.

To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function, and the function’s stage.

By default, when you create a function, it’s in the DEVELOPMENT stage. In this stage, you can test the function in the CloudFront console (or with TestFunction in the CloudFront API).

When you’re ready to use your function with a CloudFront distribution, publish the function to the LIVE stage. You can do this in the CloudFront console, with PublishFunction in the CloudFront API, or by updating the AWS::CloudFront::Function resource with the AutoPublish property set to true . When the function is published to the LIVE stage, you can attach it to a distribution’s cache behavior, using the function’s ARN.

To automatically publish the function to the LIVE stage when it’s created, set the AutoPublish property to true .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 CfnFunction cfnFunction = CfnFunction.Builder.create(this, "MyCfnFunction")
         .functionCode("functionCode")
         .functionConfig(FunctionConfigProperty.builder()
                 .comment("comment")
                 .runtime("runtime")
                 .build())
         .name("name")
         // the properties below are optional
         .autoPublish(false)
         .functionMetadata(FunctionMetadataProperty.builder()
                 .functionArn("functionArn")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFunction

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

    • CfnFunction

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

    • CfnFunction

      @Stability(Stable) public CfnFunction(@NotNull Construct scope, @NotNull String id, @NotNull CfnFunctionProps props)
      Create a new AWS::CloudFront::Function.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrFunctionArn

      @Stability(Stable) @NotNull public String getAttrFunctionArn()
      The ARN of the function. For example:.

      arn:aws:cloudfront::123456789012:function/ExampleFunction .

      To get the function ARN, use the following syntax:

      !GetAtt *Function_Logical_ID* .FunctionMetadata.FunctionARN

    • getAttrFunctionMetadataFunctionArn

      @Stability(Stable) @NotNull public String getAttrFunctionMetadataFunctionArn()
      The Amazon Resource Name (ARN) of the function.

      The ARN uniquely identifies the function.

    • getAttrStage

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFunctionCode

      @Stability(Stable) @NotNull public String getFunctionCode()
      The function code.

      For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide .

    • setFunctionCode

      @Stability(Stable) public void setFunctionCode(@NotNull String value)
      The function code.

      For more information about writing a CloudFront function, see Writing function code for CloudFront Functions in the Amazon CloudFront Developer Guide .

    • getFunctionConfig

      @Stability(Stable) @NotNull public Object getFunctionConfig()
      Contains configuration information about a CloudFront function.

    • setFunctionConfig

      @Stability(Stable) public void setFunctionConfig(@NotNull IResolvable value)
      Contains configuration information about a CloudFront function.

    • setFunctionConfig

      @Stability(Stable) public void setFunctionConfig(@NotNull CfnFunction.FunctionConfigProperty value)
      Contains configuration information about a CloudFront function.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A name to identify the function.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A name to identify the function.

    • getAutoPublish

      @Stability(Stable) @Nullable public Object getAutoPublish()
      A flag that determines whether to automatically publish the function to the LIVE stage when it’s created.

      To automatically publish to the LIVE stage, set this property to true .

    • setAutoPublish

      @Stability(Stable) public void setAutoPublish(@Nullable Boolean value)
      A flag that determines whether to automatically publish the function to the LIVE stage when it’s created.

      To automatically publish to the LIVE stage, set this property to true .

    • setAutoPublish

      @Stability(Stable) public void setAutoPublish(@Nullable IResolvable value)
      A flag that determines whether to automatically publish the function to the LIVE stage when it’s created.

      To automatically publish to the LIVE stage, set this property to true .

    • getFunctionMetadata

      @Stability(Stable) @Nullable public Object getFunctionMetadata()
      Contains metadata about a CloudFront function.

    • setFunctionMetadata

      @Stability(Stable) public void setFunctionMetadata(@Nullable IResolvable value)
      Contains metadata about a CloudFront function.

    • setFunctionMetadata

      @Stability(Stable) public void setFunctionMetadata(@Nullable CfnFunction.FunctionMetadataProperty value)
      Contains metadata about a CloudFront function.