Class: AWSCDK::IoT::CfnCommand

Inherits:
CfnResource
  • Object
show all
Includes:
AWSCDK::IInspectable, AWSCDK::ITaggableV2, AWSCDK::Interfaces::AWSIot::ICommandRef
Defined in:
io_t/cfn_command.rb

Overview

Represents the resource definition of AWS IoT Command.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCommand

Create a new AWS::IoT::Command.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::IoT::CfnCommandProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'io_t/cfn_command.rb', line 18

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

Class Method Details

.arn_for_command(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'io_t/cfn_command.rb', line 85

def self.arn_for_command(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pb3QuSUNvbW1hbmRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnCommand", "arnForCommand", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


218
219
220
 
# File 'io_t/cfn_command.rb', line 218

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

.from_command_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSIot::ICommandRef

Creates a new ICommandRef from an ARN.

Parameters:

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

Returns:



96
97
98
99
100
101
 
# File 'io_t/cfn_command.rb', line 96

def self.from_command_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_iot.CfnCommand", "fromCommandArn", [scope, id, arn])
end

.from_command_id(scope, id, command_id) ⇒ AWSCDK::Interfaces::AWSIot::ICommandRef

Creates a new ICommandRef from a commandId.

Parameters:

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

Returns:



109
110
111
112
113
114
 
# File 'io_t/cfn_command.rb', line 109

def self.from_command_id(scope, id, command_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(command_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "commandId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnCommand", "fromCommandId", [scope, id, command_id])
end

.is_cfn_command(x) ⇒ Boolean

Checks whether the given object is a CfnCommand.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


120
121
122
123
 
# File 'io_t/cfn_command.rb', line 120

def self.is_cfn_command(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_iot.CfnCommand", "isCfnCommand", [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
 
# File 'io_t/cfn_command.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_command_arn => { kind: :property, name: "attrCommandArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :command_ref => { kind: :property, name: "commandRef", is_optional: false },
    :command_id => { kind: :property, name: "commandId", is_optional: false },
    :created_at => { kind: :property, name: "createdAt", is_optional: true },
    :deprecated => { kind: :property, name: "deprecated", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :display_name => { kind: :property, name: "displayName", is_optional: true },
    :last_updated_at => { kind: :property, name: "lastUpdatedAt", is_optional: true },
    :mandatory_parameters => { kind: :property, name: "mandatoryParameters", is_optional: true },
    :namespace => { kind: :property, name: "namespace", is_optional: true },
    :payload => { kind: :property, name: "payload", is_optional: true },
    :payload_template => { kind: :property, name: "payloadTemplate", is_optional: true },
    :pending_deletion => { kind: :property, name: "pendingDeletion", is_optional: true },
    :preprocessor => { kind: :property, name: "preprocessor", is_optional: true },
    :role_arn => { kind: :property, name: "roleArn", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



444
445
446
447
 
# File 'io_t/cfn_command.rb', line 444

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:



456
457
458
459
 
# File 'io_t/cfn_command.rb', line 456

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:



466
467
468
469
 
# File 'io_t/cfn_command.rb', line 466

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:



477
478
479
480
481
 
# File 'io_t/cfn_command.rb', line 477

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.


534
535
536
537
538
 
# File 'io_t/cfn_command.rb', line 534

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.



544
545
546
547
 
# File 'io_t/cfn_command.rb', line 544

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.



556
557
558
559
560
 
# File 'io_t/cfn_command.rb', line 556

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:



569
570
571
572
 
# File 'io_t/cfn_command.rb', line 569

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:



591
592
593
594
595
596
 
# File 'io_t/cfn_command.rb', line 591

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_command_arn ⇒ String

The Amazon Resource Name (ARN) of the command.

Returns:

  • (String) 


225
226
227
 
# File 'io_t/cfn_command.rb', line 225

def attr_command_arn()
  jsii_get_property("attrCommandArn")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



232
233
234
 
# File 'io_t/cfn_command.rb', line 232

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



171
172
173
 
# File 'io_t/cfn_command.rb', line 171

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'io_t/cfn_command.rb', line 176

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


600
601
602
603
 
# File 'io_t/cfn_command.rb', line 600

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


181
182
183
 
# File 'io_t/cfn_command.rb', line 181

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


188
189
190
 
# File 'io_t/cfn_command.rb', line 188

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#command_id ⇒ String

The unique identifier of the command.

Returns:

  • (String) 


246
247
248
 
# File 'io_t/cfn_command.rb', line 246

def command_id()
  jsii_get_property("commandId")
end

#command_id=(value) ⇒ Object 



250
251
252
253
 
# File 'io_t/cfn_command.rb', line 250

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

#command_ref ⇒ AWSCDK::Interfaces::AWSIot::CommandReference

A reference to a Command resource.

Returns:



239
240
241
 
# File 'io_t/cfn_command.rb', line 239

def command_ref()
  jsii_get_property("commandRef")
end

#created_at ⇒ String?

The timestamp, when the command was created.

Returns:

  • (String, nil) 


258
259
260
 
# File 'io_t/cfn_command.rb', line 258

def created_at()
  jsii_get_property("createdAt")
end

#created_at=(value) ⇒ Object 



262
263
264
265
 
# File 'io_t/cfn_command.rb', line 262

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


133
134
135
 
# File 'io_t/cfn_command.rb', line 133

def creation_stack()
  jsii_get_property("creationStack")
end

#deprecated ⇒ Boolean, ...

Indicates whether the command has been deprecated.

Returns:



270
271
272
 
# File 'io_t/cfn_command.rb', line 270

def deprecated()
  jsii_get_property("deprecated")
end

#deprecated=(value) ⇒ Object 



274
275
276
277
 
# File 'io_t/cfn_command.rb', line 274

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

#description ⇒ String?

The description of the command parameter.

Returns:

  • (String, nil) 


282
283
284
 
# File 'io_t/cfn_command.rb', line 282

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



286
287
288
289
 
# File 'io_t/cfn_command.rb', line 286

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

#display_name ⇒ String?

The display name of the command.

Returns:

  • (String, nil) 


294
295
296
 
# File 'io_t/cfn_command.rb', line 294

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



298
299
300
301
 
# File 'io_t/cfn_command.rb', line 298

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



193
194
195
 
# File 'io_t/cfn_command.rb', line 193

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:



613
614
615
616
617
 
# File 'io_t/cfn_command.rb', line 613

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:



624
625
626
627
 
# File 'io_t/cfn_command.rb', line 624

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:



694
695
696
697
 
# File 'io_t/cfn_command.rb', line 694

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

#last_updated_at ⇒ String?

The timestamp, when the command was last updated.

Returns:

  • (String, nil) 


306
307
308
 
# File 'io_t/cfn_command.rb', line 306

def last_updated_at()
  jsii_get_property("lastUpdatedAt")
end

#last_updated_at=(value) ⇒ Object 



310
311
312
313
 
# File 'io_t/cfn_command.rb', line 310

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


145
146
147
 
# File 'io_t/cfn_command.rb', line 145

def logical_id()
  jsii_get_property("logicalId")
end

#mandatory_parameters ⇒ AWSCDK::IResolvable, ...

Returns:



316
317
318
 
# File 'io_t/cfn_command.rb', line 316

def mandatory_parameters()
  jsii_get_property("mandatoryParameters")
end

#mandatory_parameters=(value) ⇒ Object 



320
321
322
323
 
# File 'io_t/cfn_command.rb', line 320

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

#namespace ⇒ String?

The namespace to which the command belongs.

Returns:

  • (String, nil) 


328
329
330
 
# File 'io_t/cfn_command.rb', line 328

def namespace()
  jsii_get_property("namespace")
end

#namespace=(value) ⇒ Object 



332
333
334
335
 
# File 'io_t/cfn_command.rb', line 332

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


128
129
130
 
# File 'io_t/cfn_command.rb', line 128

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:



635
636
637
 
# File 'io_t/cfn_command.rb', line 635

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:



642
643
644
 
# File 'io_t/cfn_command.rb', line 642

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.



435
436
437
438
 
# File 'io_t/cfn_command.rb', line 435

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

#payload ⇒ AWSCDK::IResolvable, ...

Returns:



338
339
340
 
# File 'io_t/cfn_command.rb', line 338

def payload()
  jsii_get_property("payload")
end

#payload=(value) ⇒ Object 



342
343
344
345
346
 
# File 'io_t/cfn_command.rb', line 342

def payload=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoT::CfnCommand::CommandPayloadProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuQ29tbWFuZC5Db21tYW5kUGF5bG9hZFByb3BlcnR5In1dfX0=")), "payload") unless value.nil?
  jsii_set_property("payload", value)
end

#payload_template ⇒ String?

The payload template associated with the command.

Returns:

  • (String, nil) 


351
352
353
 
# File 'io_t/cfn_command.rb', line 351

def payload_template()
  jsii_get_property("payloadTemplate")
end

#payload_template=(value) ⇒ Object 



355
356
357
358
 
# File 'io_t/cfn_command.rb', line 355

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

#pending_deletion ⇒ Boolean, ...

Indicates whether the command is pending deletion.

Returns:



363
364
365
 
# File 'io_t/cfn_command.rb', line 363

def pending_deletion()
  jsii_get_property("pendingDeletion")
end

#pending_deletion=(value) ⇒ Object 



367
368
369
370
 
# File 'io_t/cfn_command.rb', line 367

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

#preprocessor ⇒ AWSCDK::IResolvable, ...

Returns:



373
374
375
 
# File 'io_t/cfn_command.rb', line 373

def preprocessor()
  jsii_get_property("preprocessor")
end

#preprocessor=(value) ⇒ Object 



377
378
379
380
381
 
# File 'io_t/cfn_command.rb', line 377

def preprocessor=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::IoT::CfnCommand::CommandPreprocessorProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuQ29tbWFuZC5Db21tYW5kUHJlcHJvY2Vzc29yUHJvcGVydHkifV19fQ==")), "preprocessor") unless value.nil?
  jsii_set_property("preprocessor", 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) 


164
165
166
 
# File 'io_t/cfn_command.rb', line 164

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:



653
654
655
656
 
# File 'io_t/cfn_command.rb', line 653

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


660
661
662
663
 
# File 'io_t/cfn_command.rb', line 660

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:



670
671
672
673
674
 
# File 'io_t/cfn_command.rb', line 670

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

#role_arn ⇒ String?

The customer role associated with the command.

Returns:

  • (String, nil) 


386
387
388
 
# File 'io_t/cfn_command.rb', line 386

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



390
391
392
393
 
# File 'io_t/cfn_command.rb', line 390

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



679
680
681
 
# File 'io_t/cfn_command.rb', line 679

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:



154
155
156
 
# File 'io_t/cfn_command.rb', line 154

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags to be associated with the command.

Returns:



398
399
400
 
# File 'io_t/cfn_command.rb', line 398

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



402
403
404
405
406
 
# File 'io_t/cfn_command.rb', line 402

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



411
412
413
 
# File 'io_t/cfn_command.rb', line 411

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


201
202
203
 
# File 'io_t/cfn_command.rb', line 201

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


211
212
213
 
# File 'io_t/cfn_command.rb', line 211

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


685
686
687
688
 
# File 'io_t/cfn_command.rb', line 685

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) 


424
425
426
427
428
429
 
# File 'io_t/cfn_command.rb', line 424

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