software.amazon.awscdk.services.cloudfront

Class CfnCachePolicy

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.CfnCachePolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:30.072Z")
 @Stability(value=Stable)
public class CfnCachePolicy
extends CfnResource
implements IInspectable

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

A cache policy.

When it's attached to a cache behavior, the cache policy determines the following:

• The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
• The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.

The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but not include them in the cache key, use OriginRequestPolicy .

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 A cache policy configuration.
static interface	CfnCachePolicy.CookiesConfigProperty An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
static interface	CfnCachePolicy.HeadersConfigProperty An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
static interface	CfnCachePolicy.ParametersInCacheKeyAndForwardedToOriginProperty This object determines the values that CloudFront includes in the cache key.
static interface	CfnCachePolicy.QueryStringsConfigProperty An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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(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() The unique identifier for the cache policy.
String	getAttrLastModifiedTime() The date and time when the cache policy was last modified.
Object	getCachePolicyConfig() The cache policy configuration.
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) The cache policy configuration.
void	setCachePolicyConfig(IResolvable value) The cache policy configuration.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement

getRef

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

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

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

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

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
                                               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()

The unique identifier for the cache policy.

For example: 2766f7b2-75c5-41c6-8f06-bf4303a2f2f5 .

getAttrLastModifiedTime

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

The date and time when the cache policy was last modified.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCachePolicyConfig

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

The cache policy configuration.

setCachePolicyConfig

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

The cache policy configuration.

setCachePolicyConfig

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

The cache policy configuration.