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

Class: Aws::SSM::Types::ParameterMetadata

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::ParameterMetadata

Defined in:

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

Overview

Metada includes information like the ARN of the last user and the date/time the parameter was last used.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #allowed_pattern ⇒ String

  A parameter name can include only the following letters and symbols.

• #description ⇒ String

  Description of the parameter actions.

• #key_id ⇒ String

  The ID of the query key used for this parameter.

• #last_modified_date ⇒ Time

  Date the parameter was last changed or updated.

• #last_modified_user ⇒ String

  Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

• #name ⇒ String

  The parameter name.

• #type ⇒ String

  The type of parameter.

• #version ⇒ Integer

  The parameter version.

Instance Attribute Details

#allowed_pattern ⇒ String

A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

Returns:

• (String)

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

class ParameterMetadata < Struct.new(
  :name,
  :type,
  :key_id,
  :last_modified_date,
  :last_modified_user,
  :description,
  :allowed_pattern,
  :version)
  include Aws::Structure
end

#description ⇒ String

Description of the parameter actions.

Returns:

• (String)

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

class ParameterMetadata < Struct.new(
  :name,
  :type,
  :key_id,
  :last_modified_date,
  :last_modified_user,
  :description,
  :allowed_pattern,
  :version)
  include Aws::Structure
end

#key_id ⇒ String

The ID of the query key used for this parameter.

Returns:

• (String)

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

class ParameterMetadata < Struct.new(
  :name,
  :type,
  :key_id,
  :last_modified_date,
  :last_modified_user,
  :description,
  :allowed_pattern,
  :version)
  include Aws::Structure
end

#last_modified_date ⇒ Time

Date the parameter was last changed or updated.

Returns:

• (Time)

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

class ParameterMetadata < Struct.new(
  :name,
  :type,
  :key_id,
  :last_modified_date,
  :last_modified_user,
  :description,
  :allowed_pattern,
  :version)
  include Aws::Structure
end

#last_modified_user ⇒ String

Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

Returns:

• (String)

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

class ParameterMetadata < Struct.new(
  :name,
  :type,
  :key_id,
  :last_modified_date,
  :last_modified_user,
  :description,
  :allowed_pattern,
  :version)
  include Aws::Structure
end

#name ⇒ String

The parameter name.

Returns:

• (String)

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

class ParameterMetadata < Struct.new(
  :name,
  :type,
  :key_id,
  :last_modified_date,
  :last_modified_user,
  :description,
  :allowed_pattern,
  :version)
  include Aws::Structure
end

#type ⇒ String

The type of parameter. Valid parameter types include the following: String, String list, Secure string.

Returns:

• (String)

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

class ParameterMetadata < Struct.new(
  :name,
  :type,
  :key_id,
  :last_modified_date,
  :last_modified_user,
  :description,
  :allowed_pattern,
  :version)
  include Aws::Structure
end

#version ⇒ Integer

The parameter version.

Returns:

• (Integer)

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

class ParameterMetadata < Struct.new(
  :name,
  :type,
  :key_id,
  :last_modified_date,
  :last_modified_user,
  :description,
  :allowed_pattern,
  :version)
  include Aws::Structure
end