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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::DocumentParameter

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_value ⇒ String

  If specified, the default values for the parameters.

• #description ⇒ String

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

• #name ⇒ String

  The name of the parameter.

• #type ⇒ String

  The type of parameter.

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)

# File 'lib/aws-sdk-ssm/types.rb', line 7078

class DocumentParameter < Struct.new(
  :name,
  :type,
  :description,
  :default_value)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-ssm/types.rb', line 7078

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

#name ⇒ String

The name of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 7078

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

#type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 7078

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