Class: AWSCDK::CloudFront::CachePolicy

Inherits:
Resource
  • Object
show all
Includes:
ICachePolicy
Defined in:
cloud_front/cache_policy.rb

Overview

A Cache Policy configuration.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CachePolicy.

Parameters:



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

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudFront::CachePolicyProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5DYWNoZVBvbGljeVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.AMPLIFY ⇒ AWSCDK::CloudFront::ICachePolicy

This policy is designed for use with an origin that is an AWS Amplify web app.

Returns:



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

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

.CACHING_DISABLED ⇒ AWSCDK::CloudFront::ICachePolicy

Disables caching.

This policy is useful for dynamic content and for requests that are not cacheable.

Returns:



106
107
108
 
# File 'cloud_front/cache_policy.rb', line 106

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

.CACHING_OPTIMIZED ⇒ AWSCDK::CloudFront::ICachePolicy

Optimize cache efficiency by minimizing the values that CloudFront includes in the cache key.

Query strings and cookies are not included in the cache key, and only the normalized 'Accept-Encoding' header is included.

Returns:



115
116
117
 
# File 'cloud_front/cache_policy.rb', line 115

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

.CACHING_OPTIMIZED_FOR_UNCOMPRESSED_OBJECTS ⇒ AWSCDK::CloudFront::ICachePolicy

Optimize cache efficiency by minimizing the values that CloudFront includes in the cache key.

Query strings and cookies are not included in the cache key, and only the normalized 'Accept-Encoding' header is included. Disables cache compression.

Returns:



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

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

.ELEMENTAL_MEDIA_PACKAGE ⇒ AWSCDK::CloudFront::ICachePolicy

Designed for use with an origin that is an AWS Elemental MediaPackage endpoint.

Returns:



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

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

.from_cache_policy_id(scope, id, cache_policy_id) ⇒ AWSCDK::CloudFront::ICachePolicy

Imports a Cache Policy from its id.

Parameters:

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

Returns:



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

def self.from_cache_policy_id(scope, id, cache_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(cache_policy_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cachePolicyId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.CachePolicy", "fromCachePolicyId", [scope, id, cache_policy_id])
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/cache_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 },
    :cache_policy_id => { kind: :property, name: "cachePolicyId", is_optional: false },
    :cache_policy_ref => { kind: :property, name: "cachePolicyRef", 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) 


139
140
141
 
# File 'cloud_front/cache_policy.rb', line 139

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

.USE_ORIGIN_CACHE_CONTROL_HEADERS ⇒ AWSCDK::CloudFront::ICachePolicy

Designed for use with an origin that returns Cache-Control HTTP response headers and does not serve different content based on values present in the query string.

Returns:



146
147
148
 
# File 'cloud_front/cache_policy.rb', line 146

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

.USE_ORIGIN_CACHE_CONTROL_HEADERS_QUERY_STRINGS ⇒ AWSCDK::CloudFront::ICachePolicy

Designed for use with an origin that returns Cache-Control HTTP response headers and serves different content based on values present in the query string.

Returns:



153
154
155
 
# File 'cloud_front/cache_policy.rb', line 153

def self.USE_ORIGIN_CACHE_CONTROL_HEADERS_QUERY_STRINGS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudfront.CachePolicy", "USE_ORIGIN_CACHE_CONTROL_HEADERS_QUERY_STRINGS")
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:



204
205
206
207
 
# File 'cloud_front/cache_policy.rb', line 204

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:



221
222
223
224
 
# File 'cloud_front/cache_policy.rb', line 221

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

#cache_policy_id ⇒ String

The ID of the cache policy.

Returns:

  • (String) 


160
161
162
 
# File 'cloud_front/cache_policy.rb', line 160

def cache_policy_id()
  jsii_get_property("cachePolicyId")
end

#cache_policy_ref ⇒ AWSCDK::Interfaces::AWSCloudfront::CachePolicyReference

A reference to a CachePolicy resource.

Returns:



167
168
169
 
# File 'cloud_front/cache_policy.rb', line 167

def cache_policy_ref()
  jsii_get_property("cachePolicyRef")
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/cache_policy.rb', line 69

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


227
228
229
 
# File 'cloud_front/cache_policy.rb', line 227

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) 


241
242
243
244
245
246
 
# File 'cloud_front/cache_policy.rb', line 241

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) 


256
257
258
259
 
# File 'cloud_front/cache_policy.rb', line 256

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/cache_policy.rb', line 54

def node()
  jsii_get_property("node")
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/cache_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/cache_policy.rb', line 90

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


174
175
176
 
# File 'cloud_front/cache_policy.rb', line 174

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) 


187
188
189
190
191
192
 
# File 'cloud_front/cache_policy.rb', line 187

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