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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_dateTime

The date the document was created.

Returns:

  • (Time)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end

#display_nameString

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

Returns:

  • (String)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end

#document_formatString

The document format, either JSON or YAML.

Returns:

  • (String)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

The document version.

Returns:

  • (String)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end

#is_default_versionBoolean

An identifier for the default version of the document.

Returns:

  • (Boolean)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The document name.

Returns:

  • (String)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end

#review_statusString

The current status of the approval review for the latest version of the document.

Returns:

  • (String)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end

#status_informationString

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

Returns:

  • (String)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  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 can't be changed.

Returns:

  • (String)


8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8092

class DocumentVersionInfo < Struct.new(
  :name,
  :display_name,
  :document_version,
  :version_name,
  :created_date,
  :is_default_version,
  :document_format,
  :status,
  :status_information,
  :review_status)
  SENSITIVE = []
  include Aws::Structure
end