software.amazon.awscdk.services.cloudfront

Class CachePolicy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cloudfront.CachePolicy

All Implemented Interfaces:

IConstruct, IDependable, IResource, ICachePolicy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.374Z")
public class CachePolicy
extends Resource
implements ICachePolicy

A Cache Policy configuration.

Example:

 // Using an existing cache policy for a Distribution
 S3Origin bucketOrigin;
 Distribution.Builder.create(this, "myDistManagedPolicy")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(bucketOrigin)
                 .cachePolicy(CachePolicy.CACHING_OPTIMIZED)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CachePolicy.Builder A fluent builder for CachePolicy.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudfront.ICachePolicy

ICachePolicy.Jsii$Default, ICachePolicy.Jsii$Proxy

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

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static ICachePolicy	AMPLIFY This policy is designed for use with an origin that is an AWS Amplify web app.
static ICachePolicy	CACHING_DISABLED Disables caching.
static ICachePolicy	CACHING_OPTIMIZED Optimize cache efficiency by minimizing the values that CloudFront includes in the cache key.
static ICachePolicy	CACHING_OPTIMIZED_FOR_UNCOMPRESSED_OBJECTS Optimize cache efficiency by minimizing the values that CloudFront includes in the cache key.
static ICachePolicy	ELEMENTAL_MEDIA_PACKAGE Designed for use with an origin that is an AWS Elemental MediaPackage endpoint.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CachePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CachePolicy(software.amazon.jsii.JsiiObjectRef objRef)
	CachePolicy(software.constructs.Construct scope, java.lang.String id)
	CachePolicy(software.constructs.Construct scope, java.lang.String id, CachePolicyProps props)

Method Summary

Modifier and Type	Method and Description
static ICachePolicy	fromCachePolicyId(software.constructs.Construct scope, java.lang.String id, java.lang.String cachePolicyId) Imports a Cache Policy from its id.
java.lang.String	getCachePolicyId() The ID of the cache policy.

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getNode

Field Detail

AMPLIFY

public static final ICachePolicy AMPLIFY

This policy is designed for use with an origin that is an AWS Amplify web app.

CACHING_DISABLED

public static final ICachePolicy CACHING_DISABLED

Disables caching.

This policy is useful for dynamic content and for requests that are not cacheable.

CACHING_OPTIMIZED

public static final ICachePolicy CACHING_OPTIMIZED

Optimize cache efficiency by minimizing the values that CloudFront includes in the cache key.

Query strings and cookies are not included in the cache key, and only the normalized 'Accept-Encoding' header is included.

CACHING_OPTIMIZED_FOR_UNCOMPRESSED_OBJECTS

public static final ICachePolicy CACHING_OPTIMIZED_FOR_UNCOMPRESSED_OBJECTS

Optimize cache efficiency by minimizing the values that CloudFront includes in the cache key.

Query strings and cookies are not included in the cache key, and only the normalized 'Accept-Encoding' header is included. Disables cache compression.

ELEMENTAL_MEDIA_PACKAGE

public static final ICachePolicy ELEMENTAL_MEDIA_PACKAGE

Designed for use with an origin that is an AWS Elemental MediaPackage endpoint.

Constructor Detail

CachePolicy

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

CachePolicy

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

CachePolicy

public CachePolicy(software.constructs.Construct scope,
                   java.lang.String id,
                   CachePolicyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

CachePolicy

public CachePolicy(software.constructs.Construct scope,
                   java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromCachePolicyId

public static ICachePolicy fromCachePolicyId(software.constructs.Construct scope,
                                             java.lang.String id,
                                             java.lang.String cachePolicyId)

Imports a Cache Policy from its id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

cachePolicyId - This parameter is required.

getCachePolicyId

public java.lang.String getCachePolicyId()

The ID of the cache policy.

Specified by:

getCachePolicyId in interface ICachePolicy