AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::SSM::Types::DocumentIdentifier

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

Overview

Describes the name of a Systems Manager document.

Instance Attribute Summary collapse

Instance Attribute Details

#document_formatString

The document format, either JSON or YAML.

Possible values:

  • YAML
  • JSON
  • TEXT

Returns:

  • (String)

    The document format, either JSON or YAML.

#document_typeString

The document type.

Possible values:

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

Returns:

  • (String)

    The document type.

#document_versionString

The document version.

Returns:

  • (String)

    The document version.

#nameString

The name of the Systems Manager document.

Returns:

  • (String)

    The name of the Systems Manager document.

#ownerString

The AWS user account that created the document.

Returns:

  • (String)

    The AWS user account that created the document.

#platform_typesArray<String>

The operating system platform.

Returns:

  • (Array<String>)

    The operating system platform.

#requiresArray<Types::DocumentRequires>

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

Returns:

#schema_versionString

The schema version.

Returns:

  • (String)

    The schema version.

#tagsArray<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_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 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_nameString

An optional field specifying 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)

    An optional field specifying the version of the artifact associated with the document.