Class: Aws::SSM::Types::Parameter

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::Parameter

Defined in:

gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

An Amazon Web Services Systems Manager parameter in Parameter Store.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:value]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the parameter.

• #data_type ⇒ String

  The data type of the parameter, such as text or aws:ec2:image.

• #last_modified_date ⇒ Time

  Date the parameter was last changed or updated and the parameter version was created.

• #name ⇒ String

  The name of the parameter.

• #selector ⇒ String

  Either the version number or the label used to retrieve the parameter value.

• #source_result ⇒ String

  Applies to parameters that reference information in other Amazon Web Services services.

• #type ⇒ String

  The type of parameter.

• #value ⇒ String

  The parameter value.

• #version ⇒ Integer

  The parameter version.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the parameter.

Returns:

• (String)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end

#data_type ⇒ String

The data type of the parameter, such as text or aws:ec2:image. The default is text.

Returns:

• (String)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end

#last_modified_date ⇒ Time

Date the parameter was last changed or updated and the parameter version was created.

Returns:

• (Time)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end

#name ⇒ String

The name of the parameter.

Returns:

• (String)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end

#selector ⇒ String

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

Returns:

• (String)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end

#source_result ⇒ String

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

Returns:

• (String)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end

#type ⇒ String

The type of parameter. Valid values include the following: String, StringList, and SecureString.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Returns:

• (String)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end

#value ⇒ String

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

Returns:

• (String)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end

#version ⇒ Integer

The parameter version.

Returns:

• (Integer)

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

class Parameter < Struct.new(
  :name,
  :type,
  :value,
  :version,
  :selector,
  :source_result,
  :last_modified_date,
  :arn,
  :data_type)
  SENSITIVE = [:value]
  include Aws::Structure
end