software.amazon.awscdk.services.cloudfront

Class OriginRequestPolicy

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cloudfront.OriginRequestPolicy

All Implemented Interfaces:

IConstruct, IDependable, IResource, IOriginRequestPolicy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:32.321Z")
public class OriginRequestPolicy
extends Resource
implements IOriginRequestPolicy

A Origin Request Policy configuration.

Example:

 // Using an existing origin request policy for a Distribution
 S3Origin bucketOrigin;
 Distribution.Builder.create(this, "myDistManagedPolicy")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(bucketOrigin)
                 .originRequestPolicy(OriginRequestPolicy.CORS_S3_ORIGIN)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OriginRequestPolicy.Builder A fluent builder for OriginRequestPolicy.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudfront.IOriginRequestPolicy

IOriginRequestPolicy.Jsii$Default, IOriginRequestPolicy.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static IOriginRequestPolicy	ALL_VIEWER This policy includes all values (query strings, headers, and cookies) in the viewer request.
static IOriginRequestPolicy	CORS_CUSTOM_ORIGIN This policy includes the header that enables cross-origin resource sharing (CORS) requests when the origin is a custom origin.
static IOriginRequestPolicy	CORS_S3_ORIGIN This policy includes the headers that enable cross-origin resource sharing (CORS) requests when the origin is an Amazon S3 bucket.
static IOriginRequestPolicy	ELEMENTAL_MEDIA_TAILOR This policy is designed for use with an origin that is an AWS Elemental MediaTailor endpoint.
static IOriginRequestPolicy	USER_AGENT_REFERER_HEADERS This policy includes only the User-Agent and Referer headers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OriginRequestPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	OriginRequestPolicy(software.amazon.jsii.JsiiObjectRef objRef)
	OriginRequestPolicy(software.constructs.Construct scope, java.lang.String id)
	OriginRequestPolicy(software.constructs.Construct scope, java.lang.String id, OriginRequestPolicyProps props)

Method Summary

Modifier and Type	Method and Description
static IOriginRequestPolicy	fromOriginRequestPolicyId(software.constructs.Construct scope, java.lang.String id, java.lang.String originRequestPolicyId) Imports a Origin Request Policy from its id.
java.lang.String	getOriginRequestPolicyId() The ID of the origin request policy.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Field Detail

ALL_VIEWER

public static final IOriginRequestPolicy ALL_VIEWER

This policy includes all values (query strings, headers, and cookies) in the viewer request.

CORS_CUSTOM_ORIGIN

public static final IOriginRequestPolicy CORS_CUSTOM_ORIGIN

This policy includes the header that enables cross-origin resource sharing (CORS) requests when the origin is a custom origin.

CORS_S3_ORIGIN

public static final IOriginRequestPolicy CORS_S3_ORIGIN

This policy includes the headers that enable cross-origin resource sharing (CORS) requests when the origin is an Amazon S3 bucket.

ELEMENTAL_MEDIA_TAILOR

public static final IOriginRequestPolicy ELEMENTAL_MEDIA_TAILOR

This policy is designed for use with an origin that is an AWS Elemental MediaTailor endpoint.

USER_AGENT_REFERER_HEADERS

public static final IOriginRequestPolicy USER_AGENT_REFERER_HEADERS

This policy includes only the User-Agent and Referer headers.

It doesn’t include any query strings or cookies.

Constructor Detail

OriginRequestPolicy

protected OriginRequestPolicy(software.amazon.jsii.JsiiObjectRef objRef)

OriginRequestPolicy

protected OriginRequestPolicy(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

OriginRequestPolicy

public OriginRequestPolicy(software.constructs.Construct scope,
                           java.lang.String id,
                           OriginRequestPolicyProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

OriginRequestPolicy

public OriginRequestPolicy(software.constructs.Construct scope,
                           java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromOriginRequestPolicyId

public static IOriginRequestPolicy fromOriginRequestPolicyId(software.constructs.Construct scope,
                                                             java.lang.String id,
                                                             java.lang.String originRequestPolicyId)

Imports a Origin Request Policy from its id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

originRequestPolicyId - This parameter is required.

getOriginRequestPolicyId

public java.lang.String getOriginRequestPolicyId()

The ID of the origin request policy.

Specified by:

getOriginRequestPolicyId in interface IOriginRequestPolicy