CachePolicy
cloudfront.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | cloudfront-controller/apis/v1alpha1#CachePolicy |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | CachePolicy |
ListKind | CachePolicyList |
Plural | cachepolicies |
Singular | 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.
Spec
cachePolicyConfig:
comment: string
defaultTTL: integer
maxTTL: integer
minTTL: integer
name: string
parametersInCacheKeyAndForwardedToOrigin:
cookiesConfig:
cookieBehavior: string
cookies:
items:
- string
enableAcceptEncodingBrotli: boolean
enableAcceptEncodingGzip: boolean
headersConfig:
headerBehavior: string
headers:
items:
- string
queryStringsConfig:
queryStringBehavior: string
queryStrings:
items:
- string
Field | Description |
---|---|
cachePolicyConfig Required | object A cache policy configuration. |
cachePolicyConfig.comment Optional | string |
cachePolicyConfig.defaultTTL Optional | integer |
cachePolicyConfig.maxTTL Optional | integer |
cachePolicyConfig.minTTL Optional | integer |
cachePolicyConfig.name Optional | string |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin Optional | object This object determines 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 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 an 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. |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig Optional | object 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. |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookieBehavior Optional | string |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies Optional | object Contains a list of cookie names. |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies.items Optional | array |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies.items.[] Required | string |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.enableAcceptEncodingGzip Optional | boolean |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig Optional | object 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. |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headerBehavior Optional | string |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers Optional | object Contains a list of HTTP header names. |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers.items Optional | array |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers.items.[] Required | string |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStringBehavior Optional | string |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings Optional | object Contains a list of query string names. |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings.items Optional | array |
cachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings.items.[] Required | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
eTag: string
id: string
lastModifiedTime: string
Field | Description |
---|---|
ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
controllers to indicate terminal states of the CR and its backend AWS | |
service API resource | |
conditions.[].message Optional | string A human readable message indicating details about the transition. |
conditions.[].reason Optional | string The reason for the condition’s last transition. |
conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
conditions.[].type Optional | string Type is the type of the Condition |
eTag Optional | string The current version of the cache policy. |
id Optional | string The unique identifier for the cache policy. |
lastModifiedTime Optional | string The date and time when the cache policy was last modified. |