Module: AWSCDK::CloudFront::IDistribution

Includes:
IResource, Interfaces::AWSCloudfront::IDistributionRef
Included in:
CloudFrontWebDistribution, Distribution
Defined in:
cloud_front/i_distribution.rb

Overview

Interface for CloudFront distributions.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'cloud_front/i_distribution.rb', line 119

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 },
    :distribution_ref => { kind: :property, name: "distributionRef", is_optional: false },
    :distribution_arn => { kind: :property, name: "distributionArn", is_optional: false },
    :distribution_domain_name => { kind: :property, name: "distributionDomainName", is_optional: false },
    :distribution_id => { kind: :property, name: "distributionId", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_create_invalidation => { kind: :method, name: "grantCreateInvalidation", 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:



92
93
94
95
 
# File 'cloud_front/i_distribution.rb', line 92

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

#distribution_arn ⇒ String

The distribution ARN for this distribution.

Returns:

  • (String) 


48
49
50
 
# File 'cloud_front/i_distribution.rb', line 48

def distribution_arn()
  jsii_get_property("distributionArn")
end

#distribution_domain_name ⇒ String

The domain name of the Distribution, such as d111111abcdef8.cloudfront.net.

Returns:

  • (String) 


55
56
57
 
# File 'cloud_front/i_distribution.rb', line 55

def distribution_domain_name()
  jsii_get_property("distributionDomainName")
end

#distribution_id ⇒ String

The distribution ID for this distribution.

Returns:

  • (String) 


62
63
64
 
# File 'cloud_front/i_distribution.rb', line 62

def distribution_id()
  jsii_get_property("distributionId")
end

#distribution_ref ⇒ AWSCDK::Interfaces::AWSCloudfront::DistributionReference

A reference to a Distribution resource.

Returns:



41
42
43
 
# File 'cloud_front/i_distribution.rb', line 41

def distribution_ref()
  jsii_get_property("distributionRef")
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:



27
28
29
 
# File 'cloud_front/i_distribution.rb', line 27

def env()
  jsii_get_property("env")
end

#grant(identity, *actions) ⇒ AWSCDK::IAM::Grant

Adds an IAM policy statement associated with this distribution to an IAM principal's policy.

Parameters:

  • identity (AWSCDK::IAM::IGrantable) —

    The principal.

  • actions (Array<String>) —

    The set of actions to allow (i.e. "cloudfront:ListInvalidations").

Returns:



102
103
104
105
106
107
108
 
# File 'cloud_front/i_distribution.rb', line 102

def grant(identity, *actions)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [identity, *actions])
end

#grant_create_invalidation(identity) ⇒ AWSCDK::IAM::Grant

Grant to create invalidations for this bucket to an IAM principal (Role/Group/User).

Parameters:

Returns:



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

def grant_create_invalidation(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantCreateInvalidation", [identity])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'cloud_front/i_distribution.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'cloud_front/i_distribution.rb', line 34

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



73
74
75
76
77
78
 
# File 'cloud_front/i_distribution.rb', line 73

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