Class: AWSCDK::CloudFront::OriginRequestPolicy

Inherits:
Resource
  • Object
show all
Includes:
IOriginRequestPolicy
Defined in:
cloud_front/origin_request_policy.rb

Overview

A Origin Request Policy configuration.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ OriginRequestPolicy

Returns a new instance of OriginRequestPolicy.

Parameters:



12
13
14
15
16
17
18
 
# File 'cloud_front/origin_request_policy.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudFront::OriginRequestPolicyProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5PcmlnaW5SZXF1ZXN0UG9saWN5UHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.ALL_VIEWER ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

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

Returns:



97
98
99
 
# File 'cloud_front/origin_request_policy.rb', line 97

def self.ALL_VIEWER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "ALL_VIEWER")
end

.ALL_VIEWER_AND_CLOUDFRONT_2022 ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

This policy includes all values (headers, cookies, and query strings) in the viewer request, and all CloudFront headers that were released through June 2022 (CloudFront headers released after June 2022 are not included).

Returns:



104
105
106
 
# File 'cloud_front/origin_request_policy.rb', line 104

def self.ALL_VIEWER_AND_CLOUDFRONT_2022()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "ALL_VIEWER_AND_CLOUDFRONT_2022")
end

.ALL_VIEWER_EXCEPT_HOST_HEADER ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

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

Returns:



111
112
113
 
# File 'cloud_front/origin_request_policy.rb', line 111

def self.ALL_VIEWER_EXCEPT_HOST_HEADER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "ALL_VIEWER_EXCEPT_HOST_HEADER")
end

.CORS_CUSTOM_ORIGIN ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

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

Returns:



118
119
120
 
# File 'cloud_front/origin_request_policy.rb', line 118

def self.CORS_CUSTOM_ORIGIN()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "CORS_CUSTOM_ORIGIN")
end

.CORS_S3_ORIGIN ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

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

Returns:



125
126
127
 
# File 'cloud_front/origin_request_policy.rb', line 125

def self.CORS_S3_ORIGIN()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "CORS_S3_ORIGIN")
end

.ELEMENTAL_MEDIA_TAILOR ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

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

Returns:



132
133
134
 
# File 'cloud_front/origin_request_policy.rb', line 132

def self.ELEMENTAL_MEDIA_TAILOR()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "ELEMENTAL_MEDIA_TAILOR")
end

.from_origin_request_policy_id(scope, id, origin_request_policy_id) ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

Imports a Origin Request Policy from its id.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • origin_request_policy_id (String)

Returns:



44
45
46
47
48
49
 
# File 'cloud_front/origin_request_policy.rb', line 44

def self.from_origin_request_policy_id(scope, id, origin_request_policy_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(origin_request_policy_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "originRequestPolicyId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "fromOriginRequestPolicyId", [scope, id, origin_request_policy_id])
end

.HOST_HEADER_ONLY ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

This policy includes only the Host header from the origin request.

It doesn't include any query strings or cookies.

Returns:



141
142
143
 
# File 'cloud_front/origin_request_policy.rb', line 141

def self.HOST_HEADER_ONLY()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "HOST_HEADER_ONLY")
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'cloud_front/origin_request_policy.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :origin_request_policy_id => { kind: :property, name: "originRequestPolicyId", is_optional: false },
    :origin_request_policy_ref => { kind: :property, name: "originRequestPolicyRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


148
149
150
 
# File 'cloud_front/origin_request_policy.rb', line 148

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "PROPERTY_INJECTION_ID")
end

.USER_AGENT_REFERER_HEADERS ⇒ AWSCDK::CloudFront::IOriginRequestPolicy

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

It doesn’t include any query strings or cookies.

Returns:



157
158
159
 
# File 'cloud_front/origin_request_policy.rb', line 157

def self.USER_AGENT_REFERER_HEADERS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.OriginRequestPolicy", "USER_AGENT_REFERER_HEADERS")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



208
209
210
211
 
# File 'cloud_front/origin_request_policy.rb', line 208

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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:



225
226
227
228
 
# File 'cloud_front/origin_request_policy.rb', line 225

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



69
70
71
 
# File 'cloud_front/origin_request_policy.rb', line 69

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


231
232
233
 
# File 'cloud_front/origin_request_policy.rb', line 231

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


245
246
247
248
249
250
 
# File 'cloud_front/origin_request_policy.rb', line 245

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


260
261
262
263
 
# File 'cloud_front/origin_request_policy.rb', line 260

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


54
55
56
 
# File 'cloud_front/origin_request_policy.rb', line 54

def node()
  jsii_get_property("node")
end

#origin_request_policy_id ⇒ String

The ID of the origin request policy.

Returns:

  • (String) 


164
165
166
 
# File 'cloud_front/origin_request_policy.rb', line 164

def origin_request_policy_id()
  jsii_get_property("originRequestPolicyId")
end

#origin_request_policy_ref ⇒ AWSCDK::Interfaces::AWSCloudfront::OriginRequestPolicyReference

A reference to a OriginRequestPolicy resource.

Returns:



171
172
173
 
# File 'cloud_front/origin_request_policy.rb', line 171

def origin_request_policy_ref()
  jsii_get_property("originRequestPolicyRef")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


83
84
85
 
# File 'cloud_front/origin_request_policy.rb', line 83

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



90
91
92
 
# File 'cloud_front/origin_request_policy.rb', line 90

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


178
179
180
 
# File 'cloud_front/origin_request_policy.rb', line 178

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


191
192
193
194
195
196
 
# File 'cloud_front/origin_request_policy.rb', line 191

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end