Class: AWSCDK::CloudFront::OriginAccessIdentity

Inherits:
Resource
  • Object
show all
Includes:
IOriginAccessIdentity
Defined in:
cloud_front/origin_access_identity.rb

Overview

An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of OriginAccessIdentity.

Parameters:



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

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

Class Method Details

.from_origin_access_identity_id(scope, id, origin_access_identity_id) ⇒ AWSCDK::CloudFront::IOriginAccessIdentity

Creates a OriginAccessIdentity by providing the OriginAccessIdentityId.

Parameters:

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

Returns:



48
49
50
51
52
53
 
# File 'cloud_front/origin_access_identity.rb', line 48

def self.from_origin_access_identity_id(scope, id, origin_access_identity_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_access_identity_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "originAccessIdentityId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.OriginAccessIdentity", "fromOriginAccessIdentityId", [scope, id, origin_access_identity_id])
end

.from_origin_access_identity_name(scope, id, origin_access_identity_name) ⇒ AWSCDK::CloudFront::IOriginAccessIdentity

Deprecated.

use fromOriginAccessIdentityId

Creates a OriginAccessIdentity by providing the OriginAccessIdentityId.

It is misnamed and superseded by the correctly named fromOriginAccessIdentityId.

Parameters:

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

Returns:



64
65
66
67
68
69
 
# File 'cloud_front/origin_access_identity.rb', line 64

def self.from_origin_access_identity_name(scope, id, origin_access_identity_name)
  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_access_identity_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "originAccessIdentityName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudfront.OriginAccessIdentity", "fromOriginAccessIdentityName", [scope, id, origin_access_identity_name])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'cloud_front/origin_access_identity.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 },
    :cloud_front_origin_access_identity_ref => { kind: :property, name: "cloudFrontOriginAccessIdentityRef", is_optional: false },
    :cloud_front_origin_access_identity_s3_canonical_user_id => { kind: :property, name: "cloudFrontOriginAccessIdentityS3CanonicalUserId", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :origin_access_identity_id => { kind: :property, name: "originAccessIdentityId", is_optional: false },
    :origin_access_identity_name => { kind: :property, name: "originAccessIdentityName", 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 },
    :arn => { kind: :method, name: "arn", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


117
118
119
 
# File 'cloud_front/origin_access_identity.rb', line 117

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



190
191
192
193
 
# File 'cloud_front/origin_access_identity.rb', line 190

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:



207
208
209
210
 
# File 'cloud_front/origin_access_identity.rb', line 207

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

#arn ⇒ String

The ARN to include in S3 bucket policy to allow CloudFront access.

Returns:

  • (String) 


250
251
252
 
# File 'cloud_front/origin_access_identity.rb', line 250

def arn()
  jsii_call_method("arn", [])
end

#cloud_front_origin_access_identity_ref ⇒ AWSCDK::Interfaces::AWSCloudfront::CloudFrontOriginAccessIdentityReference

A reference to a CloudFrontOriginAccessIdentity resource.

Returns:



124
125
126
 
# File 'cloud_front/origin_access_identity.rb', line 124

def cloud_front_origin_access_identity_ref()
  jsii_get_property("cloudFrontOriginAccessIdentityRef")
end

#cloud_front_origin_access_identity_s3_canonical_user_id ⇒ String

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

Returns:

  • (String) 


131
132
133
 
# File 'cloud_front/origin_access_identity.rb', line 131

def cloud_front_origin_access_identity_s3_canonical_user_id()
  jsii_get_property("cloudFrontOriginAccessIdentityS3CanonicalUserId")
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:



89
90
91
 
# File 'cloud_front/origin_access_identity.rb', line 89

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


213
214
215
 
# File 'cloud_front/origin_access_identity.rb', line 213

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) 


227
228
229
230
231
232
 
# File 'cloud_front/origin_access_identity.rb', line 227

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) 


242
243
244
245
 
# File 'cloud_front/origin_access_identity.rb', line 242

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

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

Derived principal value for bucket access.

Returns:



138
139
140
 
# File 'cloud_front/origin_access_identity.rb', line 138

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


74
75
76
 
# File 'cloud_front/origin_access_identity.rb', line 74

def node()
  jsii_get_property("node")
end

#origin_access_identity_id ⇒ String

The Origin Access Identity Id (physical id) This was called originAccessIdentityName before.

Returns:

  • (String) 


145
146
147
 
# File 'cloud_front/origin_access_identity.rb', line 145

def origin_access_identity_id()
  jsii_get_property("originAccessIdentityId")
end

#origin_access_identity_name ⇒ String

Deprecated.

use originAccessIdentityId instead

The Origin Access Identity Id (physical id) It is misnamed and superseded by the correctly named originAccessIdentityId.

Returns:

  • (String) 


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

def origin_access_identity_name()
  jsii_get_property("originAccessIdentityName")
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) 


103
104
105
 
# File 'cloud_front/origin_access_identity.rb', line 103

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



110
111
112
 
# File 'cloud_front/origin_access_identity.rb', line 110

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


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

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) 


173
174
175
176
177
178
 
# File 'cloud_front/origin_access_identity.rb', line 173

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