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

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

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

Overview

Describes a Systems Manager document.

Instance Attribute Summary collapse

Instance Attribute Details

#attachments_informationArray<Types::AttachmentInformation>

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

Returns:



5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#created_dateTime

The date when the document was created.

Returns:

  • (Time)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#default_versionString

The default version.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#descriptionString

A description of the document.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#document_formatString

The document format, either JSON or YAML.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#document_typeString

The type of document.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#document_versionString

The document version.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#hashString

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

Sha1 hashes have been deprecated.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#hash_typeString

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

Sha1 hashes have been deprecated.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#latest_versionString

The latest version of the document.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#ownerString

The AWS user account that created the document.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#parametersArray<Types::DocumentParameter>

A description of the parameters for a document.

Returns:



5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#platform_typesArray<String>

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

Returns:

  • (Array<String>)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#requiresArray<Types::DocumentRequires>

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

Returns:



5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#schema_versionString

The schema version.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#sha_1String

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

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#statusString

The status of the Systems Manager document.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#status_informationString

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)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#target_typeString

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.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end

#version_nameString

The version of the artifact associated with the document.

Returns:

  • (String)


5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5983

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,
  :requires)
  include Aws::Structure
end