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:



2311
2312
2313
2314
2315
2316
2317
2318
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2311

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

#description ⇒ String

The description of the command parameter.

Returns:

  • (String) 


2311
2312
2313
2314
2315
2316
2317
2318
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2311

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

#name ⇒ String

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

Returns:

  • (String) 


2311
2312
2313
2314
2315
2316
2317
2318
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2311

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

#value ⇒ Types::CommandParameterValue

The value used to describe the command. When you assign a value to a parameter, it will override any default value that you had already specified.

Returns:



2311
2312
2313
2314
2315
2316
2317
2318
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2311

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