Class: Aws::IoT::Types::CommandParameter

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

A map of key-value pairs that describe the command.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_value ⇒ Types::CommandParameterValue

The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

Returns:



2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2366

class CommandParameter < Struct.new(
  :name,
  :type,
  :value,
  :default_value,
  :value_conditions,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the command parameter.

Returns:

  • (String) 


2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2366

class CommandParameter < Struct.new(
  :name,
  :type,
  :value,
  :default_value,
  :value_conditions,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of a specific parameter used in a command and command execution.

Returns:

  • (String) 


2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2366

class CommandParameter < Struct.new(
  :name,
  :type,
  :value,
  :default_value,
  :value_conditions,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the command parameter.

Returns:

  • (String) 


2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2366

class CommandParameter < Struct.new(
  :name,
  :type,
  :value,
  :default_value,
  :value_conditions,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Types::CommandParameterValue

Parameter value that overrides the default value, if set.

Returns:



2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2366

class CommandParameter < Struct.new(
  :name,
  :type,
  :value,
  :default_value,
  :value_conditions,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#value_conditions ⇒ Array<Types::CommandParameterValueCondition>

The list of conditions that a command parameter value must satisfy to create a command execution.

Returns:



2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2366

class CommandParameter < Struct.new(
  :name,
  :type,
  :value,
  :default_value,
  :value_conditions,
  :description)
  SENSITIVE = []
  include Aws::Structure
end