@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 cache policy.
When it's attached to a cache behavior, the cache policy determines the following:
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();
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.
|
software.amazon.jsii.JsiiObject.InitializationMode
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnCachePolicy(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCachePolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable) public CfnCachePolicy(@NotNull Construct scope, @NotNull String id, @NotNull CfnCachePolicyProps props)
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.@Stability(value=Stable) public void inspect(@NotNull TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.@Stability(value=Stable) @NotNull public String getAttrId()
For example: 2766f7b2-75c5-41c6-8f06-bf4303a2f2f5
.
@Stability(value=Stable) @NotNull public String getAttrLastModifiedTime()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties
in class CfnResource
@Stability(value=Stable) @NotNull public Object getCachePolicyConfig()
@Stability(value=Stable) public void setCachePolicyConfig(@NotNull IResolvable value)
@Stability(value=Stable) public void setCachePolicyConfig(@NotNull CfnCachePolicy.CachePolicyConfigProperty value)
Copyright © 2023. All rights reserved.