OriginRequestPolicy
cloudfront.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | cloudfront-controller/apis/v1alpha1#OriginRequestPolicy |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | OriginRequestPolicy |
ListKind | OriginRequestPolicyList |
Plural | originrequestpolicies |
Singular | originrequestpolicy |
An origin request policy.
When it’s attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including Host, User-Agent, and X-Amz-Cf-Id.
All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can’t find an object in its cache that matches the request. If you want to send values to the origin and also include them in the cache key, use CachePolicy.
Spec
originRequestPolicyConfig:
comment: string
cookiesConfig:
cookieBehavior: string
cookies:
items:
- string
headersConfig:
headerBehavior: string
headers:
items:
- string
name: string
queryStringsConfig:
queryStringBehavior: string
queryStrings:
items:
- string
Field | Description |
---|---|
originRequestPolicyConfig Required | object An origin request policy configuration. |
originRequestPolicyConfig.comment Optional | string |
originRequestPolicyConfig.cookiesConfig Optional | object An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin. |
originRequestPolicyConfig.cookiesConfig.cookieBehavior Optional | string |
originRequestPolicyConfig.cookiesConfig.cookies Optional | object Contains a list of cookie names. |
originRequestPolicyConfig.cookiesConfig.cookies.items Optional | array |
originRequestPolicyConfig.cookiesConfig.cookies.items.[] Required | string |
originRequestPolicyConfig.headersConfig.headerBehavior Optional | string |
originRequestPolicyConfig.headersConfig.headers Optional | object Contains a list of HTTP header names. |
originRequestPolicyConfig.headersConfig.headers.items Optional | array |
originRequestPolicyConfig.headersConfig.headers.items.[] Required | string |
originRequestPolicyConfig.queryStringsConfig Optional | object An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin. |
originRequestPolicyConfig.queryStringsConfig.queryStringBehavior Optional | string |
originRequestPolicyConfig.queryStringsConfig.queryStrings Optional | object Contains a list of query string names. |
originRequestPolicyConfig.queryStringsConfig.queryStrings.items Optional | array |
originRequestPolicyConfig.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
location: 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 |
id Optional | string The unique identifier for the origin request policy. |
lastModifiedTime Optional | string The date and time when the origin request policy was last modified. |
location Optional | string |