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.104.0 (build e79254c)",
date="2024-12-06T14:43:15.404Z")
@Stability(Stable)
public class CfnCachePolicy
extends CfnResource
implements IInspectable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnCachePolicy
.static interface
A cache policy configuration.static interface
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
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
This object determines the values that CloudFront includes in the cache key.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnCachePolicy
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnCachePolicy
(software.amazon.jsii.JsiiObjectRef objRef) CfnCachePolicy
(software.constructs.Construct scope, String id, CfnCachePolicyProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe unique identifier for the cache policy.The date and time when the cache policy was last modified.The cache policy configuration.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setCachePolicyConfig
(IResolvable value) The cache policy configuration.void
The cache policy configuration.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnCachePolicy
protected CfnCachePolicy(software.amazon.jsii.JsiiObjectRef objRef) -
CfnCachePolicy
protected CfnCachePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnCachePolicy
@Stability(Stable) public CfnCachePolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCachePolicyProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The unique identifier for the cache policy.For example:
2766f7b2-75c5-41c6-8f06-bf4303a2f2f5
. -
getAttrLastModifiedTime
The date and time when the cache policy was last modified. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getCachePolicyConfig
The cache policy configuration. -
setCachePolicyConfig
The cache policy configuration. -
setCachePolicyConfig
@Stability(Stable) public void setCachePolicyConfig(@NotNull CfnCachePolicy.CachePolicyConfigProperty value) The cache policy configuration.
-