software.amazon.awscdk.services.cloudfront

Class CfnCachePolicy

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cloudfront.CfnCachePolicy

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.253Z")
 @Stability(value=Stable)
public class CfnCachePolicy
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFront::CachePolicy`.

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.*;
 CfnCachePolicy cfnCachePolicy = CfnCachePolicy.Builder.create(this, "MyCfnCachePolicy")
         .cachePolicyConfig(CachePolicyConfigProperty.builder()
                 .defaultTtl(123)
                 .maxTtl(123)
                 .minTtl(123)
                 .name("name")
                 .parametersInCacheKeyAndForwardedToOrigin(ParametersInCacheKeyAndForwardedToOriginProperty.builder()
                         .cookiesConfig(CookiesConfigProperty.builder()
                                 .cookieBehavior("cookieBehavior")
                                 // the properties below are optional
                                 .cookies(List.of("cookies"))
                                 .build())
                         .enableAcceptEncodingGzip(false)
                         .headersConfig(HeadersConfigProperty.builder()
                                 .headerBehavior("headerBehavior")
                                 // the properties below are optional
                                 .headers(List.of("headers"))
                                 .build())
                         .queryStringsConfig(QueryStringsConfigProperty.builder()
                                 .queryStringBehavior("queryStringBehavior")
                                 // the properties below are optional
                                 .queryStrings(List.of("queryStrings"))
                                 .build())
                         // the properties below are optional
                         .enableAcceptEncodingBrotli(false)
                         .build())
                 // the properties below are optional
                 .comment("comment")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCachePolicy.Builder A fluent builder for CfnCachePolicy.
static interface	CfnCachePolicy.CachePolicyConfigProperty Example:
static interface	CfnCachePolicy.CookiesConfigProperty Example:
static interface	CfnCachePolicy.HeadersConfigProperty Example:
static interface	CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty Example:
static interface	CfnCachePolicy.QueryStringsConfigProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCachePolicy(software.constructs.Construct scope, String id, CfnCachePolicyProps props) Create a new `AWS::CloudFront::CachePolicy`.
protected	CfnCachePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCachePolicy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId()
String	getAttrLastModifiedTime()
Object	getCachePolicyConfig() `AWS::CloudFront::CachePolicy.CachePolicyConfig`.
protected Map<String,Object>	getCfnProperties()
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCachePolicyConfig(CfnCachePolicy.CachePolicyConfigProperty value) `AWS::CloudFront::CachePolicy.CachePolicyConfig`.
void	setCachePolicyConfig(IResolvable value) `AWS::CloudFront::CachePolicy.CachePolicyConfig`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCachePolicy

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

CfnCachePolicy

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

CfnCachePolicy

@Stability(value=Stable)
public CfnCachePolicy(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnCachePolicyProps props)

Create a new `AWS::CloudFront::CachePolicy`.

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 Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

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

getAttrLastModifiedTime

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

getCachePolicyConfig

@Stability(value=Stable)
 @NotNull
public Object getCachePolicyConfig()

`AWS::CloudFront::CachePolicy.CachePolicyConfig`.

setCachePolicyConfig

@Stability(value=Stable)
public void setCachePolicyConfig(@NotNull
                                                          CfnCachePolicy.CachePolicyConfigProperty value)

`AWS::CloudFront::CachePolicy.CachePolicyConfig`.

setCachePolicyConfig

@Stability(value=Stable)
public void setCachePolicyConfig(@NotNull
                                                          IResolvable value)

`AWS::CloudFront::CachePolicy.CachePolicyConfig`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource