Class: AWSCDK::CfnResource

Inherits:

CfnRefElement

Object
CfnRefElement
AWSCDK::CfnResource

show all

Defined in:: cfn_resource.rb

Overview

Represents a CloudFormation resource.

Direct Known Subclasses

Class Method Summary collapse

.is_cfn_resource(x) ⇒ Boolean
Check whether the given object is a CfnResource.
.jsii_overridable_methods ⇒ Object

Instance Method Summary collapse

#add_deletion_override(path) ⇒ void
Syntactic sugar for addOverride(path, undefined).
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
#add_depends_on(target) ⇒ void deprecated Deprecated.
use addDependency
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
#cfn_properties ⇒ Hash{String => Object}
#cfn_property_name(cdk_property_name) ⇒ String^?
#cfn_property_names ⇒ Hash{String => String}
#cfn_resource_type ⇒ String
AWS resource type.
#creation_stack ⇒ Array<String>
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
#initialize(scope, id, props) ⇒ CfnResource constructor
Creates a resource construct.
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
#node ⇒ Constructs::Node
The tree node.
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
#ref ⇒ String
Return a string that will be resolved to a CloudFormation { Ref } for this element.
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
#render_properties(props) ⇒ Hash{String => Object}
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
#to_string ⇒ String
Returns a string representation of this construct.
#updated_properites ⇒ Hash{String => Object} deprecated Deprecated.
use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
#validate_properties(_properties) ⇒ void
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.

Constructor Details

#initialize(scope, id, props) ⇒ `CfnResource`

Creates a resource construct.

Parameters:

scope (Constructs::Construct)
id (String)
props (AWSCDK::CfnResourceProps)

# File 'cfn_resource.rb', line 13

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

Class Method Details

.is_cfn_resource(x) ⇒ `Boolean`

Check whether the given object is a CfnResource.

Parameters:

x (Object)

Returns:

(Boolean)

# File 'cfn_resource.rb', line 64

def self.is_cfn_resource(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.CfnResource", "isCfnResource", [x])
end

.jsii_overridable_methods ⇒ `Object`

# File 'cfn_resource.rb', line 21

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ `void`

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (String) —
The path of the value to delete.

# File 'cfn_resource.rb', line 195

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ `void`

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (AWSCDK::CfnResource)

# File 'cfn_resource.rb', line 207

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ `void`

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (AWSCDK::CfnResource)

# File 'cfn_resource.rb', line 217

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ `void`

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (String)
value (Object)

#add_override(path, value) ⇒ `void`

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (String) —
- The path of the property, you can use dot notation to override values in complex types.
value (Object) —
- The value.

# File 'cfn_resource.rb', line 284

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ `void`

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (String) —
The path to the property.

# File 'cfn_resource.rb', line 294

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ `void`

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (String) —
The path of the property.
value (Object) —
The value.

# File 'cfn_resource.rb', line 306

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ `void`

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:

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

# File 'cfn_resource.rb', line 319

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 = nil, options = nil) ⇒ `void`

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (AWSCDK::RemovalPolicy, nil) (defaults to: nil)
options (AWSCDK::RemovalPolicyOptions, nil) (defaults to: nil)

#cfn_options ⇒ `AWSCDK::ICfnResourceOptions`

Options for this resource, such as condition, update policy etc.

Returns:

(AWSCDK::ICfnResourceOptions)



115
116
117

# File 'cfn_resource.rb', line 115

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ `Hash{String => Object}`

Returns:

(Hash{String => Object})



120
121
122

# File 'cfn_resource.rb', line 120

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ `String`^?

Parameters:

cdk_property_name (String)

Returns:

(String, nil)

# File 'cfn_resource.rb', line 350

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ `Hash{String => String}`

Returns:

(Hash{String => String})



125
126
127

# File 'cfn_resource.rb', line 125

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ `String`

AWS resource type.

Returns:

(String)



132
133
134

# File 'cfn_resource.rb', line 132

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ `Array<String>`

Returns:

(Array<String>)



77
78
79

# File 'cfn_resource.rb', line 77

def creation_stack()
  jsii_get_property("creationStack")
end

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

Returns:

(AWSCDK::Interfaces::ResourceEnvironment)



137
138
139

# File 'cfn_resource.rb', line 137

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ `AWSCDK::Reference`

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (String) —
The name of the attribute.
type_hint (AWSCDK::ResolutionTypeHint, nil) (defaults to: nil)

Returns:

(AWSCDK::Reference)

# File 'cfn_resource.rb', line 363

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ `Object`

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (String)

Returns:

(Object)

#logical_id ⇒ `String`

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

(String)



89
90
91

# File 'cfn_resource.rb', line 89

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ `Constructs::Node`

The tree node.

Returns:

(Constructs::Node)



72
73
74

# File 'cfn_resource.rb', line 72

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ `Array<AWSCDK::CfnResource, AWSCDK::Stack>`

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:

(Array<AWSCDK::CfnResource, AWSCDK::Stack>)



385
386
387

# File 'cfn_resource.rb', line 385

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ `Array<AWSCDK::CfnResource>`

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:

(Array<AWSCDK::CfnResource>)



392
393
394

# File 'cfn_resource.rb', line 392

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ `void`

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (String) —
The new logical ID to use for this stack element.

# File 'cfn_resource.rb', line 186

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ `String`

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

(String)



108
109
110

# File 'cfn_resource.rb', line 108

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ `void`

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (AWSCDK::CfnResource)

# File 'cfn_resource.rb', line 403

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ `Hash{String => Object}`

Parameters:

props (Hash{String => Object})

Returns:

(Hash{String => Object})

# File 'cfn_resource.rb', line 410

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ `void`

This method returns an undefined value.

Replaces one dependency with another.

Parameters:

target (AWSCDK::CfnResource) —
The dependency to replace.
new_target (AWSCDK::CfnResource) —
The new dependency to add.

# File 'cfn_resource.rb', line 420

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ `Boolean`

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

(Boolean) —
true if the resource should be included or false is the resource should be omitted.



429
430
431

# File 'cfn_resource.rb', line 429

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ `AWSCDK::Stack`

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:

(AWSCDK::Stack)



98
99
100

# File 'cfn_resource.rb', line 98

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ `String`

Returns a string representation of this construct.

Returns:

(String) —
a string representation of this resource



162
163
164

# File 'cfn_resource.rb', line 162

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ `Hash{String => Object}`

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

(Hash{String => Object})



145
146
147

# File 'cfn_resource.rb', line 145

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ `Hash{String => Object}`

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

(Hash{String => Object})



155
156
157

# File 'cfn_resource.rb', line 155

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ `void`

This method returns an undefined value.

Parameters:

_properties (Object)

# File 'cfn_resource.rb', line 435

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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 'cfn_resource.rb', line 175

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

Overview

Direct Known Subclasses

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnResource

Class Method Details

.is_cfn_resource(x) ⇒ Boolean

.jsii_overridable_methods ⇒ Object

Instance Method Details

#add_deletion_override(path) ⇒ void

#add_dependency(target) ⇒ void

#add_depends_on(target) ⇒ void

#add_metadata(key, value) ⇒ void

#add_override(path, value) ⇒ void

#add_property_deletion_override(property_path) ⇒ void

#add_property_override(property_path, value) ⇒ void

#apply_cross_stack_reference_strength(strength) ⇒ void

#apply_removal_policy(policy = nil, options = nil) ⇒ void

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

#cfn_properties ⇒ Hash{String => Object}

#cfn_property_name(cdk_property_name) ⇒ String?

#cfn_property_names ⇒ Hash{String => String}

#cfn_resource_type ⇒ String

#creation_stack ⇒ Array<String>

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

#get_metadata(key) ⇒ Object

#logical_id ⇒ String

#node ⇒ Constructs::Node

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

#override_logical_id(new_logical_id) ⇒ void

#ref ⇒ String

#remove_dependency(target) ⇒ void

#render_properties(props) ⇒ Hash{String => Object}

#replace_dependency(target, new_target) ⇒ void

#should_synthesize ⇒ Boolean

#stack ⇒ AWSCDK::Stack

#to_string ⇒ String

#updated_properites ⇒ Hash{String => Object}

#updated_properties ⇒ Hash{String => Object}

#validate_properties(_properties) ⇒ void

#with(*mixins) ⇒ Constructs::IConstruct

#initialize(scope, id, props) ⇒ `CfnResource`

.is_cfn_resource(x) ⇒ `Boolean`

.jsii_overridable_methods ⇒ `Object`

#add_deletion_override(path) ⇒ `void`

#add_dependency(target) ⇒ `void`

#add_depends_on(target) ⇒ `void`

#add_metadata(key, value) ⇒ `void`

#add_override(path, value) ⇒ `void`

#add_property_deletion_override(property_path) ⇒ `void`

#add_property_override(property_path, value) ⇒ `void`

#apply_cross_stack_reference_strength(strength) ⇒ `void`

#apply_removal_policy(policy = nil, options = nil) ⇒ `void`

#cfn_options ⇒ `AWSCDK::ICfnResourceOptions`

#cfn_properties ⇒ `Hash{String => Object}`

#cfn_property_name(cdk_property_name) ⇒ `String`^?

#cfn_property_names ⇒ `Hash{String => String}`

#cfn_resource_type ⇒ `String`

#creation_stack ⇒ `Array<String>`

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

#get_att(attribute_name, type_hint = nil) ⇒ `AWSCDK::Reference`

#get_metadata(key) ⇒ `Object`

#logical_id ⇒ `String`

#node ⇒ `Constructs::Node`

#obtain_dependencies ⇒ `Array<AWSCDK::CfnResource, AWSCDK::Stack>`

#obtain_resource_dependencies ⇒ `Array<AWSCDK::CfnResource>`

#override_logical_id(new_logical_id) ⇒ `void`

#ref ⇒ `String`

#remove_dependency(target) ⇒ `void`

#render_properties(props) ⇒ `Hash{String => Object}`

#replace_dependency(target, new_target) ⇒ `void`

#should_synthesize ⇒ `Boolean`

#stack ⇒ `AWSCDK::Stack`

#to_string ⇒ `String`

#updated_properites ⇒ `Hash{String => Object}`

#updated_properties ⇒ `Hash{String => Object}`

#validate_properties(_properties) ⇒ `void`

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