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
- Struct
- Aws::SSM::Types::DocumentIdentifier
- Defined in:
- (unknown)
Overview
Describes the name of a Systems Manager document.
Instance Attribute Summary collapse
-
#document_format ⇒ String
The document format, either JSON or YAML.
-
#document_type ⇒ String
The document type.
-
#document_version ⇒ String
The document version.
-
#name ⇒ String
The name of the Systems Manager document.
-
#owner ⇒ String
The AWS user account that created the document.
-
#platform_types ⇒ Array<String>
The operating system platform.
-
#requires ⇒ Array<Types::DocumentRequires>
A list of SSM documents required by a document.
-
#schema_version ⇒ String
The schema version.
-
#tags ⇒ 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.
-
#version_name ⇒ String
An optional field specifying the version of the artifact associated with the document.
Instance Attribute Details
#document_format ⇒ String
The document format, either JSON or YAML.
Possible values:
- YAML
- JSON
- TEXT
#document_type ⇒ String
The document type.
Possible values:
- Command
- Policy
- Automation
- Session
- Package
- ApplicationConfiguration
- ApplicationConfigurationSchema
- DeploymentStrategy
- ChangeCalendar
#document_version ⇒ String
The document version.
#name ⇒ String
The name of the Systems Manager document.
#owner ⇒ String
The AWS user account that created the document.
#platform_types ⇒ Array<String>
The operating system platform.
#requires ⇒ Array<Types::DocumentRequires>
A list of SSM documents required by a document. For example, an
ApplicationConfiguration
document requires an
ApplicationConfigurationSchema
document.
#schema_version ⇒ String
The schema version.
#tags ⇒ 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.
#version_name ⇒ String
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.