Package software.amazon.awscdk.services.cloudfront

Interface CfnFunctionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:24.744Z")
@Stability(Stable)
public interface CfnFunctionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFunction.

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.*;
 CfnFunctionProps cfnFunctionProps = CfnFunctionProps.builder()
         .functionCode("functionCode")
         .functionConfig(FunctionConfigProperty.builder()
                 .comment("comment")
                 .runtime("runtime")
                 // the properties below are optional
                 .keyValueStoreAssociations(List.of(KeyValueStoreAssociationProperty.builder()
                         .keyValueStoreArn("keyValueStoreArn")
                         .build()))
                 .build())
         .name("name")
         // the properties below are optional
         .autoPublish(false)
         .functionMetadata(FunctionMetadataProperty.builder()
                 .functionArn("functionArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFunctionProps.Builder	A builder for CfnFunctionProps
static final class	CfnFunctionProps.Jsii$Proxy	An implementation for CfnFunctionProps

Method Summary

Modifier and Type	Method	Description
static CfnFunctionProps.Builder	builder()
default Object	getAutoPublish()	A flag that determines whether to automatically publish the function to the LIVE stage when it’s created.
String	getFunctionCode()	The function code.
Object	getFunctionConfig()	Contains configuration information about a CloudFront function.
default Object	getFunctionMetadata()	Contains metadata about a CloudFront function.
String	getName()	A name to identify the function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFunctionCode

@Stability(Stable)
@NotNull
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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functioncode

getFunctionConfig

@Stability(Stable)
@NotNull
Object getFunctionConfig()

Contains configuration information about a CloudFront function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functionconfig

getName

@Stability(Stable)
@NotNull
String getName()

A name to identify the function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-name

getAutoPublish

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-autopublish

getFunctionMetadata

@Stability(Stable)
@Nullable
default Object getFunctionMetadata()

Contains metadata about a CloudFront function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functionmetadata

builder

@Stability(Stable)
static CfnFunctionProps.Builder builder()

Returns:

a CfnFunctionProps.Builder of CfnFunctionProps