You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#default_valueString

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

Returns:

  • (String)

    If specified, the default values for the parameters.

#descriptionString

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

Returns:

  • (String)

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

#nameString

The name of the parameter.

Returns:

  • (String)

    The name of the parameter.

#typeString

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

Possible values:

  • String
  • StringList

Returns:

  • (String)

    The type of parameter.