Class: AWSCDK::IoT::CfnCommandProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t/cfn_command_props.rb

Overview

Properties for defining a CfnCommand.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(command_id:, created_at: nil, deprecated: nil, description: nil, display_name: nil, last_updated_at: nil, mandatory_parameters: nil, namespace: nil, payload: nil, payload_template: nil, pending_deletion: nil, preprocessor: nil, role_arn: nil, tags: nil) ⇒ CfnCommandProps

Returns a new instance of CfnCommandProps.

Parameters:

  • command_id (String) —

    The unique identifier of the command.

  • created_at (String, nil) (defaults to: nil) —

    The timestamp, when the command was created.

  • deprecated (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether the command has been deprecated.

  • description (String, nil) (defaults to: nil) —

    The description of the command parameter.

  • display_name (String, nil) (defaults to: nil) —

    The display name of the command.

  • last_updated_at (String, nil) (defaults to: nil) —

    The timestamp, when the command was last updated.

  • mandatory_parameters (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::IoT::CfnCommand::CommandParameterProperty>, nil) (defaults to: nil)
  • namespace (String, nil) (defaults to: nil) —

    The namespace to which the command belongs.

  • payload (AWSCDK::IResolvable, AWSCDK::IoT::CfnCommand::CommandPayloadProperty, nil) (defaults to: nil)
  • payload_template (String, nil) (defaults to: nil) —

    The payload template associated with the command.

  • pending_deletion (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Indicates whether the command is pending deletion.

  • preprocessor (AWSCDK::IResolvable, AWSCDK::IoT::CfnCommand::CommandPreprocessorProperty, nil) (defaults to: nil)
  • role_arn (String, nil) (defaults to: nil) —

    The customer role associated with the command.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags to be associated with the command.



23
24
25
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
 
# File 'io_t/cfn_command_props.rb', line 23

def initialize(command_id:, created_at: nil, deprecated: nil, description: nil, display_name: nil, last_updated_at: nil, mandatory_parameters: nil, namespace: nil, payload: nil, payload_template: nil, pending_deletion: nil, preprocessor: nil, role_arn: nil, tags: nil)
  @command_id = command_id
  Jsii::Type.check_type(@command_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "commandId")
  @created_at = created_at
  Jsii::Type.check_type(@created_at, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "createdAt") unless @created_at.nil?
  @deprecated = deprecated
  Jsii::Type.check_type(@deprecated, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deprecated") unless @deprecated.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless @display_name.nil?
  @last_updated_at = last_updated_at
  Jsii::Type.check_type(@last_updated_at, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lastUpdatedAt") unless @last_updated_at.nil?
  @mandatory_parameters = mandatory_parameters
  Jsii::Type.check_type(@mandatory_parameters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90LkNmbkNvbW1hbmQuQ29tbWFuZFBhcmFtZXRlclByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "mandatoryParameters") unless @mandatory_parameters.nil?
  @namespace = namespace
  Jsii::Type.check_type(@namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespace") unless @namespace.nil?
  @payload = payload.is_a?(Hash) ? ::AWSCDK::IoT::CfnCommand::CommandPayloadProperty.new(**payload.transform_keys(&:to_sym)) : payload
  Jsii::Type.check_type(@payload, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuQ29tbWFuZC5Db21tYW5kUGF5bG9hZFByb3BlcnR5In1dfX0=")), "payload") unless @payload.nil?
  @payload_template = payload_template
  Jsii::Type.check_type(@payload_template, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "payloadTemplate") unless @payload_template.nil?
  @pending_deletion = pending_deletion
  Jsii::Type.check_type(@pending_deletion, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "pendingDeletion") unless @pending_deletion.nil?
  @preprocessor = preprocessor.is_a?(Hash) ? ::AWSCDK::IoT::CfnCommand::CommandPreprocessorProperty.new(**preprocessor.transform_keys(&:to_sym)) : preprocessor
  Jsii::Type.check_type(@preprocessor, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3QuQ2ZuQ29tbWFuZC5Db21tYW5kUHJlcHJvY2Vzc29yUHJvcGVydHkifV19fQ==")), "preprocessor") unless @preprocessor.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#command_id ⇒ String (readonly)

The unique identifier of the command.

Returns:

  • (String)

See Also:



58
59
60
 
# File 'io_t/cfn_command_props.rb', line 58

def command_id
  @command_id
end

#created_at ⇒ String? (readonly)

The timestamp, when the command was created.

Returns:

  • (String, nil)

See Also:



63
64
65
 
# File 'io_t/cfn_command_props.rb', line 63

def created_at
  @created_at
end

#deprecated ⇒ Boolean, ... (readonly)

Indicates whether the command has been deprecated.

Returns:

See Also:



68
69
70
 
# File 'io_t/cfn_command_props.rb', line 68

def deprecated
  @deprecated
end

#description ⇒ String? (readonly)

The description of the command parameter.

Returns:

  • (String, nil)

See Also:



73
74
75
 
# File 'io_t/cfn_command_props.rb', line 73

def description
  @description
end

#display_name ⇒ String? (readonly)

The display name of the command.

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'io_t/cfn_command_props.rb', line 78

def display_name
  @display_name
end

#last_updated_at ⇒ String? (readonly)

The timestamp, when the command was last updated.

Returns:

  • (String, nil)

See Also:



83
84
85
 
# File 'io_t/cfn_command_props.rb', line 83

def last_updated_at
  @last_updated_at
end

#mandatory_parameters ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



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

def mandatory_parameters
  @mandatory_parameters
end

#namespace ⇒ String? (readonly)

The namespace to which the command belongs.

Returns:

  • (String, nil)

See Also:



91
92
93
 
# File 'io_t/cfn_command_props.rb', line 91

def namespace
  @namespace
end

#payload ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



94
95
96
 
# File 'io_t/cfn_command_props.rb', line 94

def payload
  @payload
end

#payload_template ⇒ String? (readonly)

The payload template associated with the command.

Returns:

  • (String, nil)

See Also:



99
100
101
 
# File 'io_t/cfn_command_props.rb', line 99

def payload_template
  @payload_template
end

#pending_deletion ⇒ Boolean, ... (readonly)

Indicates whether the command is pending deletion.

Returns:

See Also:



104
105
106
 
# File 'io_t/cfn_command_props.rb', line 104

def pending_deletion
  @pending_deletion
end

#preprocessor ⇒ AWSCDK::IResolvable, ... (readonly)

Returns:

See Also:



107
108
109
 
# File 'io_t/cfn_command_props.rb', line 107

def preprocessor
  @preprocessor
end

#role_arn ⇒ String? (readonly)

The customer role associated with the command.

Returns:

  • (String, nil)

See Also:



112
113
114
 
# File 'io_t/cfn_command_props.rb', line 112

def role_arn
  @role_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags to be associated with the command.

Returns:

See Also:



117
118
119
 
# File 'io_t/cfn_command_props.rb', line 117

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'io_t/cfn_command_props.rb', line 119

def self.jsii_properties
  {
    :command_id => "commandId",
    :created_at => "createdAt",
    :deprecated => "deprecated",
    :description => "description",
    :display_name => "displayName",
    :last_updated_at => "lastUpdatedAt",
    :mandatory_parameters => "mandatoryParameters",
    :namespace => "namespace",
    :payload => "payload",
    :payload_template => "payloadTemplate",
    :pending_deletion => "pendingDeletion",
    :preprocessor => "preprocessor",
    :role_arn => "roleArn",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'io_t/cfn_command_props.rb', line 138

def to_jsii
  result = {}
  result.merge!({
    "commandId" => @command_id,
    "createdAt" => @created_at,
    "deprecated" => @deprecated,
    "description" => @description,
    "displayName" => @display_name,
    "lastUpdatedAt" => @last_updated_at,
    "mandatoryParameters" => @mandatory_parameters,
    "namespace" => @namespace,
    "payload" => @payload,
    "payloadTemplate" => @payload_template,
    "pendingDeletion" => @pending_deletion,
    "preprocessor" => @preprocessor,
    "roleArn" => @role_arn,
    "tags" => @tags,
  })
  result.compact
end