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

Class: Aws::SSM::Types::DocumentVersionInfo

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

Overview

Version information about the document.

Instance Attribute Summary collapse

Instance Attribute Details

#created_dateTime

The date the document was created.

Returns:

  • (Time)


5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5624

class DocumentVersionInfo < Struct.new(
  :name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information)
  include Aws::Structure
end

#document_formatString

The document format, either JSON or YAML.

Returns:

  • (String)


5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5624

class DocumentVersionInfo < Struct.new(
  :name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information)
  include Aws::Structure
end

#document_versionString

The document version.

Returns:

  • (String)


5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5624

class DocumentVersionInfo < Struct.new(
  :name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information)
  include Aws::Structure
end

#is_default_versionBoolean

An identifier for the default version of the document.

Returns:

  • (Boolean)


5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5624

class DocumentVersionInfo < Struct.new(
  :name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information)
  include Aws::Structure
end

#nameString

The document name.

Returns:

  • (String)


5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5624

class DocumentVersionInfo < Struct.new(
  :name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information)
  include Aws::Structure
end

#statusString

The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.

Returns:

  • (String)


5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5624

class DocumentVersionInfo < Struct.new(
  :name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information)
  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)


5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5624

class DocumentVersionInfo < Struct.new(
  :name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information)
  include Aws::Structure
end

#version_nameString

The version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Returns:

  • (String)


5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5624

class DocumentVersionInfo < Struct.new(
  :name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information)
  include Aws::Structure
end