Class: AWSCDK::CloudFormation::CfnTypeActivation

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSCloudformation::ITypeActivationRef
Defined in:
cloud_formation/cfn_type_activation.rb

Overview

The AWS::CloudFormation::TypeActivation resource activates a public third-party extension, making it available for use in stack templates.

For information about the CloudFormation registry, see Managing extensions with the CloudFormation registry in the CloudFormation User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::CloudFormation::TypeActivation.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::CloudFormation::CfnTypeActivationProps, nil) (defaults to: nil) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'cloud_formation/cfn_type_activation.rb', line 19

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

Class Method Details

.arn_for_type_activation(resource) ⇒ String

Parameters:

Returns:

  • (String) 


81
82
83
84
 
# File 'cloud_formation/cfn_type_activation.rb', line 81

def self.arn_for_type_activation(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jbG91ZGZvcm1hdGlvbi5JVHlwZUFjdGl2YXRpb25SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cloudformation.CfnTypeActivation", "arnForTypeActivation", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


188
189
190
 
# File 'cloud_formation/cfn_type_activation.rb', line 188

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cloudformation.CfnTypeActivation", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_type_activation(x) ⇒ Boolean

Checks whether the given object is a CfnTypeActivation.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


90
91
92
93
 
# File 'cloud_formation/cfn_type_activation.rb', line 90

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

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'cloud_formation/cfn_type_activation.rb', line 27

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 },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :type_activation_ref => { kind: :property, name: "typeActivationRef", is_optional: false },
    :auto_update => { kind: :property, name: "autoUpdate", is_optional: true },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: true },
    :logging_config => { kind: :property, name: "loggingConfig", is_optional: true },
    :major_version => { kind: :property, name: "majorVersion", is_optional: true },
    :public_type_arn => { kind: :property, name: "publicTypeArn", is_optional: true },
    :publisher_id => { kind: :property, name: "publisherId", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :type_name => { kind: :property, name: "typeName", is_optional: true },
    :type_name_alias => { kind: :property, name: "typeNameAlias", is_optional: true },
    :version_bump => { kind: :property, name: "versionBump", is_optional: true },
    :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 },
    :inspect => { kind: :method, name: "inspect", 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.



363
364
365
366
 
# File 'cloud_formation/cfn_type_activation.rb', line 363

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:



375
376
377
378
 
# File 'cloud_formation/cfn_type_activation.rb', line 375

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:



385
386
387
388
 
# File 'cloud_formation/cfn_type_activation.rb', line 385

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)

See Also:



396
397
398
399
400
 
# File 'cloud_formation/cfn_type_activation.rb', line 396

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

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

# Example automatically generated from non-compiling source. May contain errors.
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.


453
454
455
456
457
 
# File 'cloud_formation/cfn_type_activation.rb', line 453

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.



463
464
465
466
 
# File 'cloud_formation/cfn_type_activation.rb', line 463

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.



475
476
477
478
479
 
# File 'cloud_formation/cfn_type_activation.rb', line 475

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:



488
489
490
491
 
# File 'cloud_formation/cfn_type_activation.rb', line 488

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:

See Also:



510
511
512
513
514
515
 
# File 'cloud_formation/cfn_type_activation.rb', line 510

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the activated extension in this account and Region.

Returns:

  • (String) 


195
196
197
 
# File 'cloud_formation/cfn_type_activation.rb', line 195

def attr_arn()
  jsii_get_property("attrArn")
end

#auto_update ⇒ Boolean, ...

Whether to automatically update the extension in this account and Region when a new minor version is published by the extension publisher.

Returns:



209
210
211
 
# File 'cloud_formation/cfn_type_activation.rb', line 209

def auto_update()
  jsii_get_property("autoUpdate")
end

#auto_update=(value) ⇒ Object 



213
214
215
216
 
# File 'cloud_formation/cfn_type_activation.rb', line 213

def auto_update=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoUpdate") unless value.nil?
  jsii_set_property("autoUpdate", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



141
142
143
 
# File 'cloud_formation/cfn_type_activation.rb', line 141

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


146
147
148
 
# File 'cloud_formation/cfn_type_activation.rb', line 146

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


519
520
521
522
 
# File 'cloud_formation/cfn_type_activation.rb', line 519

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}) 


151
152
153
 
# File 'cloud_formation/cfn_type_activation.rb', line 151

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


158
159
160
 
# File 'cloud_formation/cfn_type_activation.rb', line 158

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


103
104
105
 
# File 'cloud_formation/cfn_type_activation.rb', line 103

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



163
164
165
 
# File 'cloud_formation/cfn_type_activation.rb', line 163

def env()
  jsii_get_property("env")
end

#execution_role_arn ⇒ String?

The name of the IAM execution role to use to activate the extension.

Returns:

  • (String, nil) 


221
222
223
 
# File 'cloud_formation/cfn_type_activation.rb', line 221

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object 



225
226
227
228
 
# File 'cloud_formation/cfn_type_activation.rb', line 225

def execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn") unless value.nil?
  jsii_set_property("executionRoleArn", value)
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:

Returns:



532
533
534
535
536
 
# File 'cloud_formation/cfn_type_activation.rb', line 532

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)

See Also:



543
544
545
546
 
# File 'cloud_formation/cfn_type_activation.rb', line 543

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



613
614
615
616
 
# File 'cloud_formation/cfn_type_activation.rb', line 613

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logging_config ⇒ AWSCDK::IResolvable, ...

Specifies logging configuration information for an extension.

Returns:



233
234
235
 
# File 'cloud_formation/cfn_type_activation.rb', line 233

def logging_config()
  jsii_get_property("loggingConfig")
end

#logging_config=(value) ⇒ Object 



237
238
239
240
241
 
# File 'cloud_formation/cfn_type_activation.rb', line 237

def logging_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CloudFormation::CfnTypeActivation::LoggingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jbG91ZGZvcm1hdGlvbi5DZm5UeXBlQWN0aXZhdGlvbi5Mb2dnaW5nQ29uZmlnUHJvcGVydHkifV19fQ==")), "loggingConfig") unless value.nil?
  jsii_set_property("loggingConfig", value)
end

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


115
116
117
 
# File 'cloud_formation/cfn_type_activation.rb', line 115

def logical_id()
  jsii_get_property("logicalId")
end

#major_version ⇒ String?

The major version of this extension you want to activate, if multiple major versions are available.

Returns:

  • (String, nil) 


246
247
248
 
# File 'cloud_formation/cfn_type_activation.rb', line 246

def major_version()
  jsii_get_property("majorVersion")
end

#major_version=(value) ⇒ Object 



250
251
252
253
 
# File 'cloud_formation/cfn_type_activation.rb', line 250

def major_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "majorVersion") unless value.nil?
  jsii_set_property("majorVersion", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


98
99
100
 
# File 'cloud_formation/cfn_type_activation.rb', line 98

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:



554
555
556
 
# File 'cloud_formation/cfn_type_activation.rb', line 554

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:



561
562
563
 
# File 'cloud_formation/cfn_type_activation.rb', line 561

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.



354
355
356
357
 
# File 'cloud_formation/cfn_type_activation.rb', line 354

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

#public_type_arn ⇒ String?

The Amazon Resource Number (ARN) of the public extension.

Returns:

  • (String, nil) 


258
259
260
 
# File 'cloud_formation/cfn_type_activation.rb', line 258

def public_type_arn()
  jsii_get_property("publicTypeArn")
end

#public_type_arn=(value) ⇒ Object 



262
263
264
265
 
# File 'cloud_formation/cfn_type_activation.rb', line 262

def public_type_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "publicTypeArn") unless value.nil?
  jsii_set_property("publicTypeArn", value)
end

#publisher_id ⇒ String?

The ID of the extension publisher.

Returns:

  • (String, nil) 


270
271
272
 
# File 'cloud_formation/cfn_type_activation.rb', line 270

def publisher_id()
  jsii_get_property("publisherId")
end

#publisher_id=(value) ⇒ Object 



274
275
276
277
 
# File 'cloud_formation/cfn_type_activation.rb', line 274

def publisher_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "publisherId") unless value.nil?
  jsii_set_property("publisherId", value)
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) 


134
135
136
 
# File 'cloud_formation/cfn_type_activation.rb', line 134

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:



572
573
574
575
 
# File 'cloud_formation/cfn_type_activation.rb', line 572

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}) 


579
580
581
582
 
# File 'cloud_formation/cfn_type_activation.rb', line 579

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:



589
590
591
592
593
 
# File 'cloud_formation/cfn_type_activation.rb', line 589

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.



598
599
600
 
# File 'cloud_formation/cfn_type_activation.rb', line 598

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:



124
125
126
 
# File 'cloud_formation/cfn_type_activation.rb', line 124

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



330
331
332
 
# File 'cloud_formation/cfn_type_activation.rb', line 330

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

#type ⇒ String?

The extension type.

Returns:

  • (String, nil) 


282
283
284
 
# File 'cloud_formation/cfn_type_activation.rb', line 282

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



286
287
288
289
 
# File 'cloud_formation/cfn_type_activation.rb', line 286

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless value.nil?
  jsii_set_property("type", value)
end

#type_activation_ref ⇒ AWSCDK::Interfaces::AWSCloudformation::TypeActivationReference

A reference to a TypeActivation resource.

Returns:



202
203
204
 
# File 'cloud_formation/cfn_type_activation.rb', line 202

def type_activation_ref()
  jsii_get_property("typeActivationRef")
end

#type_name ⇒ String?

The name of the extension.

Returns:

  • (String, nil) 


294
295
296
 
# File 'cloud_formation/cfn_type_activation.rb', line 294

def type_name()
  jsii_get_property("typeName")
end

#type_name=(value) ⇒ Object 



298
299
300
301
 
# File 'cloud_formation/cfn_type_activation.rb', line 298

def type_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "typeName") unless value.nil?
  jsii_set_property("typeName", value)
end

#type_name_alias ⇒ String?

An alias to assign to the public extension in this account and Region.

Returns:

  • (String, nil) 


306
307
308
 
# File 'cloud_formation/cfn_type_activation.rb', line 306

def type_name_alias()
  jsii_get_property("typeNameAlias")
end

#type_name_alias=(value) ⇒ Object 



310
311
312
313
 
# File 'cloud_formation/cfn_type_activation.rb', line 310

def type_name_alias=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "typeNameAlias") unless value.nil?
  jsii_set_property("typeNameAlias", value)
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}) 


171
172
173
 
# File 'cloud_formation/cfn_type_activation.rb', line 171

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}) 


181
182
183
 
# File 'cloud_formation/cfn_type_activation.rb', line 181

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


604
605
606
607
 
# File 'cloud_formation/cfn_type_activation.rb', line 604

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#version_bump ⇒ String?

Manually updates a previously-activated type to a new major or minor version, if available.

Returns:

  • (String, nil) 


318
319
320
 
# File 'cloud_formation/cfn_type_activation.rb', line 318

def version_bump()
  jsii_get_property("versionBump")
end

#version_bump=(value) ⇒ Object 



322
323
324
325
 
# File 'cloud_formation/cfn_type_activation.rb', line 322

def version_bump=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionBump") unless value.nil?
  jsii_set_property("versionBump", value)
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) 


343
344
345
346
347
348
 
# File 'cloud_formation/cfn_type_activation.rb', line 343

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