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:
Resource
A Origin Request Policy configuration.
- Resource:
AWS::CloudFront::OriginRequestPolicy
- ExampleMetadata:
infused
Example:
# Using an existing origin request policy for a Distribution # bucket_origin: origins.S3Origin cloudfront.Distribution(self, "myDistManagedPolicy", default_behavior=cloudfront.BehaviorOptions( origin=bucket_origin, origin_request_policy=cloudfront.OriginRequestPolicy.CORS_S3_ORIGIN ) )
- Parameters:
scope (
Construct
) –id (
str
) –comment (
Optional
[str
]) – A comment to describe the origin request policy. Default: - no commentcookie_behavior (
Optional
[OriginRequestCookieBehavior
]) – The cookies from viewer requests to include in origin requests. Default: OriginRequestCookieBehavior.none()header_behavior (
Optional
[OriginRequestHeaderBehavior
]) – 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
]) – A unique name to identify the origin request policy. The name must only include ‘-’, ‘_’, or alphanumeric characters. Default: - generated from theid
query_string_behavior (
Optional
[OriginRequestQueryStringBehavior
]) – The URL query strings from viewer requests to include in origin requests. Default: OriginRequestQueryStringBehavior.none()
Methods
- apply_removal_policy(policy)
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
RemovalPolicy
) –- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- ALL_VIEWER = <jsii._reference_map.InterfaceDynamicProxy object>
- ALL_VIEWER_AND_CLOUDFRONT_2022 = <jsii._reference_map.InterfaceDynamicProxy object>
- ALL_VIEWER_EXCEPT_HOST_HEADER = <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.
- node
The tree node.
- origin_request_policy_id
The ID of the origin request policy.
- stack
The stack in which this resource is defined.
Static Methods
- classmethod from_origin_request_policy_id(scope, id, origin_request_policy_id)
Imports a Origin Request Policy from its id.
- Parameters:
scope (
Construct
) –id (
str
) –origin_request_policy_id (
str
) –
- Return type:
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool