Module: AWSCDK::CloudFront::IOriginAccessIdentity

Includes:
IAM::IGrantable, IResource, Interfaces::AWSCloudfront::ICloudFrontOriginAccessIdentityRef
Included in:
OriginAccessIdentity
Defined in:
cloud_front/i_origin_access_identity.rb

Overview

Interface for CloudFront OriginAccessIdentity.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'cloud_front/i_origin_access_identity.rb', line 99

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :cloud_front_origin_access_identity_ref => { kind: :property, name: "cloudFrontOriginAccessIdentityRef", 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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#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:



94
95
96
97
 
# File 'cloud_front/i_origin_access_identity.rb', line 94

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

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

A reference to a CloudFrontOriginAccessIdentity resource.

Returns:



49
50
51
 
# File 'cloud_front/i_origin_access_identity.rb', line 49

def cloud_front_origin_access_identity_ref()
  jsii_get_property("cloudFrontOriginAccessIdentityRef")
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:



28
29
30
 
# File 'cloud_front/i_origin_access_identity.rb', line 28

def env()
  jsii_get_property("env")
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



42
43
44
 
# File 'cloud_front/i_origin_access_identity.rb', line 42

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


13
14
15
 
# File 'cloud_front/i_origin_access_identity.rb', line 13

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) 


56
57
58
 
# File 'cloud_front/i_origin_access_identity.rb', line 56

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) 


64
65
66
 
# File 'cloud_front/i_origin_access_identity.rb', line 64

def origin_access_identity_name()
  jsii_get_property("originAccessIdentityName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



35
36
37
 
# File 'cloud_front/i_origin_access_identity.rb', line 35

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



75
76
77
78
79
80
 
# File 'cloud_front/i_origin_access_identity.rb', line 75

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