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

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

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

Overview

Describes a Systems Manager document.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attachments_information ⇒ Array<Types::AttachmentInformation>

Details about the document attachments, including names, locations, sizes, and so on.

Returns:

#created_date ⇒ Time

The date when the document was created.

Returns:

  • (Time) —

    The date when the document was created.

#default_version ⇒ String

The default version.

Returns:

  • (String) —

    The default version.

#description ⇒ String

A description of the document.

Returns:

  • (String) —

    A description of the document.

#document_format ⇒ String

The document format, either JSON or YAML.

Possible values:

  • YAML
  • JSON
  • TEXT

Returns:

  • (String) —

    The document format, either JSON or YAML.

#document_type ⇒ String

The type of document.

Possible values:

  • Command
  • Policy
  • Automation
  • Session
  • Package
  • ApplicationConfiguration
  • ApplicationConfigurationSchema
  • DeploymentStrategy
  • ChangeCalendar

Returns:

  • (String) —

    The type of document.

#document_version ⇒ String

The document version.

Returns:

  • (String) —

    The document version.

#hash ⇒ String

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

Sha1 hashes have been deprecated.

Returns:

  • (String) —

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

#hash_type ⇒ String

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

Sha1 hashes have been deprecated.

Possible values:

  • Sha256
  • Sha1

Returns:

  • (String) —

    The hash type of the document.

#latest_version ⇒ String

The latest version of the document.

Returns:

  • (String) —

    The latest version of the document.

#name ⇒ String

The name of the Systems Manager document.

Returns:

  • (String) —

    The name of the Systems Manager document.

#owner ⇒ String

The AWS user account that created the document.

Returns:

  • (String) —

    The AWS user account that created the document.

#parameters ⇒ Array<Types::DocumentParameter>

A description of the parameters for a document.

Returns:

#platform_types ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#requires ⇒ Array<Types::DocumentRequires>

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Returns:

#schema_version ⇒ String

The schema version.

Returns:

  • (String) —

    The schema version.

#sha_1 ⇒ String

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

Returns:

  • (String) —

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

#status ⇒ String

The status of the Systems Manager document.

Possible values:

  • Creating
  • Active
  • Updating
  • Deleting
  • Failed

Returns:

  • (String) —

    The status of the Systems Manager document.

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

    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.

Returns:

  • (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. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide.

Returns:

  • (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.

Returns:

  • (String) —

    The version of the artifact associated with the document.