Class: Aws::SSM::Types::DocumentParameter

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Parameters specified in a System Manager document that run on the server when the command is run.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#default_value ⇒ String

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

Returns:

  • (String) 


6203
6204
6205
6206
6207
6208
6209
 
# File 'lib/aws-sdk-ssm/types.rb', line 6203

class DocumentParameter < Struct.new(
  :name,
  :type,
  :description,
  :default_value)
  include Aws::Structure
end

#description ⇒ String

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

Returns:

  • (String) 


6203
6204
6205
6206
6207
6208
6209
 
# File 'lib/aws-sdk-ssm/types.rb', line 6203

class DocumentParameter < Struct.new(
  :name,
  :type,
  :description,
  :default_value)
  include Aws::Structure
end

#name ⇒ String

The name of the parameter.

Returns:

  • (String) 


6203
6204
6205
6206
6207
6208
6209
 
# File 'lib/aws-sdk-ssm/types.rb', line 6203

class DocumentParameter < Struct.new(
  :name,
  :type,
  :description,
  :default_value)
  include Aws::Structure
end

#type ⇒ String

The type of parameter. The type can be either String or StringList.

Returns:

  • (String) 


6203
6204
6205
6206
6207
6208
6209
 
# File 'lib/aws-sdk-ssm/types.rb', line 6203

class DocumentParameter < Struct.new(
  :name,
  :type,
  :description,
  :default_value)
  include Aws::Structure
end