Class: Aws::SSM::Types::DocumentDescription

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::DocumentDescription

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

Describes a Systems Manager document.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #attachments_information ⇒ Array<Types::AttachmentInformation>

  Details about the document attachments, including names, locations, sizes, etc.

• #created_date ⇒ Time

  The date when the document was created.

• #default_version ⇒ String

  The default version.

• #description ⇒ String

  A description of the document.

• #document_format ⇒ String

  The document format, either JSON or YAML.

• #document_type ⇒ String

  The type of document.

• #document_version ⇒ String

  The document version.

• #hash ⇒ String

  The Sha256 or Sha1 hash created by the system when the document was created.

• #hash_type ⇒ String

  The hash type of the document.

• #latest_version ⇒ String

  The latest version of the document.

• #name ⇒ String

  The name of the Systems Manager document.

• #owner ⇒ String

  The AWS user account that created the document.

• #parameters ⇒ Array<Types::DocumentParameter>

  A description of the parameters for a document.

• #platform_types ⇒ Array<String>

  The list of OS platforms compatible with this Systems Manager document.

• #schema_version ⇒ String

  The schema version.

• #sha_1 ⇒ String

  The SHA1 hash of the document, which you can use for verification.

• #status ⇒ String

  The status of the Systems Manager document.

• #status_information ⇒ String

  A message returned by AWS Systems Manager that explains the ‘Status` value.

• #tags ⇒ Array<Types::Tag>

  The tags, or metadata, that have been applied to the document.

• #target_type ⇒ String

  The target type which defines the kinds of resources the document can run on.

• #version_name ⇒ String

  The version of the artifact associated with the document.

Instance Attribute Details

#attachments_information ⇒ Array<Types::AttachmentInformation>

Details about the document attachments, including names, locations, sizes, etc.

Returns:

• (Array<Types::AttachmentInformation>)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#created_date ⇒ Time

The date when the document was created.

Returns:

• (Time)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#default_version ⇒ String

The default version.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#description ⇒ String

A description of the document.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#document_format ⇒ String

The document format, either JSON or YAML.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#document_type ⇒ String

The type of document.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#document_version ⇒ String

The document version.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#hash ⇒ String

The Sha256 or Sha1 hash created by the system when the document was created.

<note markdown=“1”> Sha1 hashes have been deprecated.

</note>

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#hash_type ⇒ String

The hash type of the document. Valid values include ‘Sha256` or `Sha1`.

<note markdown=“1”> Sha1 hashes have been deprecated.

</note>

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#latest_version ⇒ String

The latest version of the document.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#name ⇒ String

The name of the Systems Manager document.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#owner ⇒ String

The AWS user account that created the document.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#parameters ⇒ Array<Types::DocumentParameter>

A description of the parameters for a document.

Returns:

• (Array<Types::DocumentParameter>)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#platform_types ⇒ Array<String>

The list of OS platforms compatible with this Systems Manager document.

Returns:

• (Array<String>)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#schema_version ⇒ String

The schema version.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#sha_1 ⇒ String

The SHA1 hash of the document, which you can use for verification.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#status ⇒ String

The status of the Systems Manager document.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#status_information ⇒ String

A message returned by AWS Systems Manager that explains the ‘Status` value. For example, a `Failed` status might be explained by the `StatusInformation` message, “The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.”

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags, or metadata, that have been applied to the document.

Returns:

• (Array<Types::Tag>)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#target_type ⇒ String

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see [AWS Resource Types Reference] in the *AWS CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end

#version_name ⇒ String

The version of the artifact associated with the document.

Returns:

• (String)

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

class DocumentDescription < Struct.new(
  :sha_1,
  :hash,
  :hash_type,
  :name,
  :version_name,
  :owner,
  :created_date,
  :status,
  :status_information,
  :document_version,
  :description,
  :parameters,
  :platform_types,
  :document_type,
  :schema_version,
  :latest_version,
  :default_version,
  :document_format,
  :target_type,
  :tags,
  :attachments_information)
  include Aws::Structure
end