OriginRequestPolicy

class aws_cdk.aws_cloudfront.OriginRequestPolicy(scope, id, *, comment=None, cookie_behavior=None, header_behavior=None, origin_request_policy_name=None, query_string_behavior=None)

Bases: aws_cdk.core.Resource

(experimental) A Origin Request Policy configuration.

Stability

experimental

Resource

AWS::CloudFront::OriginRequestPolicy

Parameters
  • scope (Construct) –

  • id (str) –

  • comment (Optional[str]) – (experimental) A comment to describe the origin request policy. Default: - no comment

  • cookie_behavior (Optional[OriginRequestCookieBehavior]) – (experimental) The cookies from viewer requests to include in origin requests. Default: OriginRequestCookieBehavior.none()

  • header_behavior (Optional[OriginRequestHeaderBehavior]) – (experimental) The HTTP headers to include in origin requests. These can include headers from viewer requests and additional headers added by CloudFront. Default: OriginRequestHeaderBehavior.none()

  • origin_request_policy_name (Optional[str]) – (experimental) A unique name to identify the origin request policy. The name must only include ‘-‘, ‘_’, or alphanumeric characters. Default: - generated from the id

  • query_string_behavior (Optional[OriginRequestQueryStringBehavior]) – (experimental) The URL query strings from viewer requests to include in origin requests. Default: OriginRequestQueryStringBehavior.none()

Stability

experimental

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

ALL_VIEWER = <jsii._reference_map.InterfaceDynamicProxy object>
CORS_CUSTOM_ORIGIN = <jsii._reference_map.InterfaceDynamicProxy object>
CORS_S3_ORIGIN = <jsii._reference_map.InterfaceDynamicProxy object>
ELEMENTAL_MEDIA_TAILOR = <jsii._reference_map.InterfaceDynamicProxy object>
USER_AGENT_REFERER_HEADERS = <jsii._reference_map.InterfaceDynamicProxy object>
env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

origin_request_policy_id

(experimental) The ID of the origin request policy.

Stability

experimental

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_origin_request_policy_id(scope, id, origin_request_policy_id)

(experimental) Imports a Origin Request Policy from its id.

Parameters
  • scope (Construct) –

  • id (str) –

  • origin_request_policy_id (str) –

Stability

experimental

Return type

IOriginRequestPolicy

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool