Class: AWSCDK::IoTTwinMaker::CfnComponentType

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSIottwinmaker::IComponentTypeRef
Defined in:
io_t_twin_maker/cfn_component_type.rb

Overview

Use the AWS::IoTTwinMaker::ComponentType resource to declare a component type.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnComponentType

Create a new AWS::IoTTwinMaker::ComponentType.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::IoTTwinMaker::CfnComponentTypeProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 18

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

Class Method Details

.arn_for_component_type(resource) ⇒ String

Parameters:

Returns:

  • (String) 


90
91
92
93
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 90

def self.arn_for_component_type(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3R0d2lubWFrZXIuSUNvbXBvbmVudFR5cGVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iottwinmaker.CfnComponentType", "arnForComponentType", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


197
198
199
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 197

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

.is_cfn_component_type(x) ⇒ Boolean

Checks whether the given object is a CfnComponentType.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


99
100
101
102
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 99

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

.jsii_overridable_methods ⇒ Object 



26
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
78
79
80
81
82
83
84
85
86
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 26

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 },
    :attr_creation_date_time => { kind: :property, name: "attrCreationDateTime", is_optional: false },
    :attr_is_abstract => { kind: :property, name: "attrIsAbstract", is_optional: false },
    :attr_is_schema_initialized => { kind: :property, name: "attrIsSchemaInitialized", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_error => { kind: :property, name: "attrStatusError", is_optional: false },
    :attr_status_error_code => { kind: :property, name: "attrStatusErrorCode", is_optional: false },
    :attr_status_error_message => { kind: :property, name: "attrStatusErrorMessage", is_optional: false },
    :attr_status_state => { kind: :property, name: "attrStatusState", is_optional: false },
    :attr_update_date_time => { kind: :property, name: "attrUpdateDateTime", is_optional: false },
    :component_type_ref => { kind: :property, name: "componentTypeRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :component_type_id => { kind: :property, name: "componentTypeId", is_optional: false },
    :workspace_id => { kind: :property, name: "workspaceId", is_optional: false },
    :composite_component_types => { kind: :property, name: "compositeComponentTypes", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :extends_from => { kind: :property, name: "extendsFrom", is_optional: true },
    :functions => { kind: :property, name: "functions", is_optional: true },
    :is_singleton => { kind: :property, name: "isSingleton", is_optional: true },
    :property_definitions => { kind: :property, name: "propertyDefinitions", is_optional: true },
    :property_groups => { kind: :property, name: "propertyGroups", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



431
432
433
434
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 431

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:



443
444
445
446
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 443

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:



453
454
455
456
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 453

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:



464
465
466
467
468
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 464

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.


521
522
523
524
525
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 521

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.



531
532
533
534
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 531

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.



543
544
545
546
547
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 543

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:



556
557
558
559
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 556

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:



578
579
580
581
582
583
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 578

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 ARN of the component type.

Returns:

  • (String) 


204
205
206
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 204

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_creation_date_time ⇒ String

The date and time when the component type was created.

Returns:

  • (String) 


211
212
213
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 211

def attr_creation_date_time()
  jsii_get_property("attrCreationDateTime")
end

#attr_is_abstract ⇒ AWSCDK::IResolvable

A boolean value that specifies whether the component type is abstract.

Returns:



218
219
220
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 218

def attr_is_abstract()
  jsii_get_property("attrIsAbstract")
end

#attr_is_schema_initialized ⇒ AWSCDK::IResolvable

A boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

Returns:



225
226
227
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 225

def attr_is_schema_initialized()
  jsii_get_property("attrIsSchemaInitialized")
end

#attr_status ⇒ AWSCDK::IResolvable

Returns:



230
231
232
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 230

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_error ⇒ AWSCDK::IResolvable

Returns:



235
236
237
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 235

def attr_status_error()
  jsii_get_property("attrStatusError")
end

#attr_status_error_code ⇒ String

Returns:

  • (String) 


240
241
242
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 240

def attr_status_error_code()
  jsii_get_property("attrStatusErrorCode")
end

#attr_status_error_message ⇒ String

Returns:

  • (String) 


245
246
247
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 245

def attr_status_error_message()
  jsii_get_property("attrStatusErrorMessage")
end

#attr_status_state ⇒ String

Returns:

  • (String) 


250
251
252
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 250

def attr_status_state()
  jsii_get_property("attrStatusState")
end

#attr_update_date_time ⇒ String

The component type the update time.

Returns:

  • (String) 


257
258
259
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 257

def attr_update_date_time()
  jsii_get_property("attrUpdateDateTime")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



150
151
152
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 150

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


155
156
157
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 155

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


587
588
589
590
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 587

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


160
161
162
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 160

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


167
168
169
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 167

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#component_type_id ⇒ String

The ID of the component type.

Returns:

  • (String) 


278
279
280
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 278

def component_type_id()
  jsii_get_property("componentTypeId")
end

#component_type_id=(value) ⇒ Object 



282
283
284
285
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 282

def component_type_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "componentTypeId")
  jsii_set_property("componentTypeId", value)
end

#component_type_ref ⇒ AWSCDK::Interfaces::AWSIottwinmaker::ComponentTypeReference

A reference to a ComponentType resource.

Returns:



264
265
266
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 264

def component_type_ref()
  jsii_get_property("componentTypeRef")
end

#composite_component_types ⇒ AWSCDK::IResolvable, ...

Maps strings to compositeComponentTypes of the componentType .

Returns:



302
303
304
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 302

def composite_component_types()
  jsii_get_property("compositeComponentTypes")
end

#composite_component_types=(value) ⇒ Object 



306
307
308
309
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 306

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


112
113
114
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 112

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the component type.

Returns:

  • (String, nil) 


314
315
316
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 314

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



318
319
320
321
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 318

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



172
173
174
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 172

def env()
  jsii_get_property("env")
end

#extends_from ⇒ Array<String>?

The name of the parent component type that this component type extends.

Returns:

  • (Array<String>, nil) 


326
327
328
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 326

def extends_from()
  jsii_get_property("extendsFrom")
end

#extends_from=(value) ⇒ Object 



330
331
332
333
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 330

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

#functions ⇒ AWSCDK::IResolvable, ...

An object that maps strings to the functions in the component type.

Returns:



338
339
340
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 338

def functions()
  jsii_get_property("functions")
end

#functions=(value) ⇒ Object 



342
343
344
345
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 342

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



600
601
602
603
604
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 600

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:



611
612
613
614
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 611

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:



681
682
683
684
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 681

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

#is_singleton ⇒ Boolean, ...

A boolean value that specifies whether an entity can have more than one component of this type.

Returns:



350
351
352
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 350

def is_singleton()
  jsii_get_property("isSingleton")
end

#is_singleton=(value) ⇒ Object 



354
355
356
357
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 354

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


124
125
126
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 124

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


107
108
109
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 107

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:



622
623
624
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 622

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:



629
630
631
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 629

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.



422
423
424
425
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 422

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

#property_definitions ⇒ AWSCDK::IResolvable, ...

An object that maps strings to the property definitions in the component type.

Returns:



362
363
364
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 362

def property_definitions()
  jsii_get_property("propertyDefinitions")
end

#property_definitions=(value) ⇒ Object 



366
367
368
369
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 366

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

#property_groups ⇒ AWSCDK::IResolvable, ...

An object that maps strings to the property groups in the component type.

Returns:



374
375
376
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 374

def property_groups()
  jsii_get_property("propertyGroups")
end

#property_groups=(value) ⇒ Object 



378
379
380
381
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 378

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


143
144
145
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 143

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:



640
641
642
643
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 640

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


647
648
649
650
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 647

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:



657
658
659
660
661
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 657

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.



666
667
668
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 666

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:



133
134
135
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 133

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



271
272
273
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 271

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

The ComponentType tags.

Returns:

  • (Hash{String => String}, nil) 


386
387
388
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 386

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



390
391
392
393
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 390

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



398
399
400
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 398

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


180
181
182
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 180

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


190
191
192
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 190

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


672
673
674
675
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 672

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) 


411
412
413
414
415
416
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 411

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

#workspace_id ⇒ String

The ID of the workspace that contains the component type.

Returns:

  • (String) 


290
291
292
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 290

def workspace_id()
  jsii_get_property("workspaceId")
end

#workspace_id=(value) ⇒ Object 



294
295
296
297
 
# File 'io_t_twin_maker/cfn_component_type.rb', line 294

def workspace_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workspaceId")
  jsii_set_property("workspaceId", value)
end