Class: AWSCDK::IoTSiteWise::CfnAssetModel

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggable, AWSCDK::Interfaces::AWSIotsitewise::IAssetModelRef
Defined in:
io_t_site_wise/cfn_asset_model.rb

Overview

Creates an asset model from specified property and hierarchy definitions.

You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the AWS IoT SiteWise User Guide .

You can create three types of asset models, ASSET_MODEL , COMPONENT_MODEL , or an INTERFACE .

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.
  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.
  • INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnAssetModel

Create a new AWS::IoTSiteWise::AssetModel.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::IoTSiteWise::CfnAssetModelProps) —

    Resource properties.



26
27
28
29
30
31
32
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 26

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

Class Method Details

.arn_for_asset_model(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 89

def self.arn_for_asset_model(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3RzaXRld2lzZS5JQXNzZXRNb2RlbFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotsitewise.CfnAssetModel", "arnForAssetModel", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


222
223
224
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 222

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

.from_asset_model_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIotsitewise::IAssetModelRef

Creates a new IAssetModelRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



100
101
102
103
104
105
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 100

def self.from_asset_model_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotsitewise.CfnAssetModel", "fromAssetModelArn", [scope, id, arn])
end

.from_asset_model_id(scope, id, asset_model_id) ⇒ AWSCDK::Interfaces::AWSIotsitewise::IAssetModelRef

Creates a new IAssetModelRef from a assetModelId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • asset_model_id (String)

Returns:



113
114
115
116
117
118
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 113

def self.from_asset_model_id(scope, id, asset_model_id)
  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(asset_model_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "assetModelId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iotsitewise.CfnAssetModel", "fromAssetModelId", [scope, id, asset_model_id])
end

.is_cfn_asset_model(x) ⇒ Boolean

Checks whether the given object is a CfnAssetModel.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


124
125
126
127
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 124

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 34

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 },
    :asset_model_ref => { kind: :property, name: "assetModelRef", is_optional: false },
    :attr_asset_model_arn => { kind: :property, name: "attrAssetModelArn", is_optional: false },
    :attr_asset_model_id => { kind: :property, name: "attrAssetModelId", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :asset_model_name => { kind: :property, name: "assetModelName", is_optional: false },
    :asset_model_composite_models => { kind: :property, name: "assetModelCompositeModels", is_optional: true },
    :asset_model_description => { kind: :property, name: "assetModelDescription", is_optional: true },
    :asset_model_external_id => { kind: :property, name: "assetModelExternalId", is_optional: true },
    :asset_model_hierarchies => { kind: :property, name: "assetModelHierarchies", is_optional: true },
    :asset_model_properties => { kind: :property, name: "assetModelProperties", is_optional: true },
    :asset_model_type => { kind: :property, name: "assetModelType", is_optional: true },
    :enforced_asset_model_interface_relationships => { kind: :property, name: "enforcedAssetModelInterfaceRelationships", 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.



399
400
401
402
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 399

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:



411
412
413
414
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 411

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:



421
422
423
424
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 421

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:



432
433
434
435
436
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 432

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.


489
490
491
492
493
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 489

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.



499
500
501
502
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 499

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.



511
512
513
514
515
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 511

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:



524
525
526
527
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 524

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:



546
547
548
549
550
551
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 546

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

#asset_model_composite_models ⇒ AWSCDK::IResolvable, ...

The composite models that are part of this asset model.

Returns:



269
270
271
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 269

def asset_model_composite_models()
  jsii_get_property("assetModelCompositeModels")
end

#asset_model_composite_models=(value) ⇒ Object 



273
274
275
276
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 273

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

#asset_model_description ⇒ String?

A description for the asset model.

Returns:

  • (String, nil) 


281
282
283
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 281

def asset_model_description()
  jsii_get_property("assetModelDescription")
end

#asset_model_description=(value) ⇒ Object 



285
286
287
288
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 285

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

#asset_model_external_id ⇒ String?

The external ID of the asset model.

Returns:

  • (String, nil) 


293
294
295
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 293

def asset_model_external_id()
  jsii_get_property("assetModelExternalId")
end

#asset_model_external_id=(value) ⇒ Object 



297
298
299
300
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 297

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

#asset_model_hierarchies ⇒ AWSCDK::IResolvable, ...

The hierarchy definitions of the asset model.

Returns:



305
306
307
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 305

def asset_model_hierarchies()
  jsii_get_property("assetModelHierarchies")
end

#asset_model_hierarchies=(value) ⇒ Object 



309
310
311
312
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 309

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

#asset_model_name ⇒ String

A unique name for the asset model.

Returns:

  • (String) 


257
258
259
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 257

def asset_model_name()
  jsii_get_property("assetModelName")
end

#asset_model_name=(value) ⇒ Object 



261
262
263
264
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 261

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

#asset_model_properties ⇒ AWSCDK::IResolvable, ...

The property definitions of the asset model.

Returns:



317
318
319
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 317

def asset_model_properties()
  jsii_get_property("assetModelProperties")
end

#asset_model_properties=(value) ⇒ Object 



321
322
323
324
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 321

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

#asset_model_ref ⇒ AWSCDK::Interfaces::AWSIotsitewise::AssetModelReference

A reference to a AssetModel resource.

Returns:



229
230
231
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 229

def asset_model_ref()
  jsii_get_property("assetModelRef")
end

#asset_model_type ⇒ String?

The type of asset model.

Returns:

  • (String, nil) 


329
330
331
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 329

def asset_model_type()
  jsii_get_property("assetModelType")
end

#asset_model_type=(value) ⇒ Object 



333
334
335
336
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 333

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

#attr_asset_model_arn ⇒ String

The ARN of the asset model, which has the following format.

Returns:

  • (String) 


236
237
238
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 236

def attr_asset_model_arn()
  jsii_get_property("attrAssetModelArn")
end

#attr_asset_model_id ⇒ String

The ID of the asset model.

Returns:

  • (String) 


243
244
245
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 243

def attr_asset_model_id()
  jsii_get_property("attrAssetModelId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



175
176
177
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 175

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 180

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


555
556
557
558
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 555

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


185
186
187
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 185

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


192
193
194
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 192

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


137
138
139
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 137

def creation_stack()
  jsii_get_property("creationStack")
end

#enforced_asset_model_interface_relationships ⇒ AWSCDK::IResolvable, ...

a list of asset model and interface relationships.

Returns:



341
342
343
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 341

def enforced_asset_model_interface_relationships()
  jsii_get_property("enforcedAssetModelInterfaceRelationships")
end

#enforced_asset_model_interface_relationships=(value) ⇒ Object 



345
346
347
348
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 345

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



197
198
199
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 197

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:

Returns:



568
569
570
571
572
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 568

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:



579
580
581
582
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 579

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:



649
650
651
652
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 649

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


149
150
151
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 149

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


132
133
134
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 132

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:



590
591
592
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 590

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:



597
598
599
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 597

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.



390
391
392
393
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 390

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) 


168
169
170
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 168

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:



608
609
610
611
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 608

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


615
616
617
618
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 615

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:



625
626
627
628
629
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 625

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.



634
635
636
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 634

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:



158
159
160
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 158

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



250
251
252
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 250

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A list of key-value pairs that contain metadata for the asset.

Returns:



353
354
355
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 353

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



357
358
359
360
361
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 357

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "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



366
367
368
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 366

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


205
206
207
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 205

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


215
216
217
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 215

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


640
641
642
643
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 640

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) 


379
380
381
382
383
384
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 379

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