Class: AWSCDK::Resource

Inherits:

Constructs::Construct

Object
Constructs::Construct
AWSCDK::Resource

show all

Includes:: IResource

Defined in:: resource.rb

Overview

An L2 construct which represents an AWS resource.

Direct Known Subclasses

Class Method Summary collapse

.is_owned_resource(construct) ⇒ Boolean
Returns true if the construct was created by CDK, and false otherwise.
.is_resource(construct) ⇒ Boolean
Check whether the given construct is a Resource.
.jsii_overridable_methods ⇒ Object

Instance Method Summary collapse

#apply_cross_stack_reference_strength(strength) ⇒ void
Override the cross-stack reference strength for this resource.
#apply_removal_policy(policy) ⇒ void
Apply the given removal policy to this resource.
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
The environment this resource belongs to.
#generate_physical_name ⇒ String
#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).
#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).
#initialize(scope, id, props = nil) ⇒ Resource constructor
A new instance of Resource.
#node ⇒ Constructs::Node
The tree node.
#physical_name ⇒ String
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
#stack ⇒ AWSCDK::Stack
The stack in which this resource is defined.
#to_string ⇒ String
Returns a string representation of this construct.
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.

Constructor Details

#initialize(scope, id, props = nil) ⇒ `Resource`

Returns a new instance of Resource.

Parameters:

scope (Constructs::Construct)
id (String)
props (AWSCDK::ResourceProps, nil) (defaults to: nil)

# File 'resource.rb', line 12

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

Class Method Details

.is_owned_resource(construct) ⇒ `Boolean`

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (Constructs::IConstruct)

Returns:

(Boolean)

# File 'resource.rb', line 40

def self.is_owned_resource(construct)
  Jsii::Type.check_type(construct, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklDb25zdHJ1Y3QifQ==")), "construct")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.Resource", "isOwnedResource", [construct])
end

.is_resource(construct) ⇒ `Boolean`

Check whether the given construct is a Resource.

Parameters:

construct (Constructs::IConstruct)

Returns:

(Boolean)

# File 'resource.rb', line 49

def self.is_resource(construct)
  Jsii::Type.check_type(construct, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklDb25zdHJ1Y3QifQ==")), "construct")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.Resource", "isResource", [construct])
end

.jsii_overridable_methods ⇒ `Object`

# File 'resource.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 },
    :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

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:

strength (AWSCDK::ReferenceStrength) —
- The reference strength to use for this resource.

# File 'resource.rb', line 130

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:

policy (AWSCDK::RemovalPolicy)

# File 'resource.rb', line 147

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:

(AWSCDK::Interfaces::ResourceEnvironment)



72
73
74

# File 'resource.rb', line 72

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ `String`

Returns:

(String)



153
154
155

# File 'resource.rb', line 153

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)

# File 'resource.rb', line 167

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)

# File 'resource.rb', line 182

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)



57
58
59

# File 'resource.rb', line 57

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)



86
87
88

# File 'resource.rb', line 86

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ `AWSCDK::Stack`

The stack in which this resource is defined.

Returns:

(AWSCDK::Stack)



93
94
95

# File 'resource.rb', line 93

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ `String`

Returns a string representation of this construct.

Returns:

(String)



100
101
102

# File 'resource.rb', line 100

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)

# File 'resource.rb', line 113

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

Class: AWSCDK::Resource

Overview

Direct Known Subclasses

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Class Method Details

.is_owned_resource(construct) ⇒ Boolean

.is_resource(construct) ⇒ Boolean

.jsii_overridable_methods ⇒ Object

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

#apply_removal_policy(policy) ⇒ void

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

#generate_physical_name ⇒ String

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

#get_resource_name_attribute(name_attr) ⇒ String

#node ⇒ Constructs::Node

#physical_name ⇒ String

#stack ⇒ AWSCDK::Stack

#to_string ⇒ String

#with(*mixins) ⇒ Constructs::IConstruct

#initialize(scope, id, props = nil) ⇒ `Resource`

.is_owned_resource(construct) ⇒ `Boolean`

.is_resource(construct) ⇒ `Boolean`

.jsii_overridable_methods ⇒ `Object`

#apply_cross_stack_reference_strength(strength) ⇒ `void`

#apply_removal_policy(policy) ⇒ `void`

#env ⇒ `AWSCDK::Interfaces::ResourceEnvironment`

#generate_physical_name ⇒ `String`

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ `String`

#get_resource_name_attribute(name_attr) ⇒ `String`

#node ⇒ `Constructs::Node`

#physical_name ⇒ `String`

#stack ⇒ `AWSCDK::Stack`

#to_string ⇒ `String`

#with(*mixins) ⇒ `Constructs::IConstruct`