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

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

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

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)


3814
3815
3816
3817
3818
3819
3820
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3814

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

#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)


3814
3815
3816
3817
3818
3819
3820
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3814

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

#nameString

The name of the parameter.

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3814

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

#typeString

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

Returns:

  • (String)


3814
3815
3816
3817
3818
3819
3820
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3814

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