Class: Aws::SSM::Types::CreateDocumentRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::CreateDocumentRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
When making an API call, you may pass CreateDocumentRequest data as a hash:
{
content: "DocumentContent", # required
requires: [
{
name: "DocumentARN", # required
version: "DocumentVersion",
},
],
attachments: [
{
key: "SourceUrl", # accepts SourceUrl, S3FileUrl
values: ["AttachmentsSourceValue"],
name: "AttachmentIdentifier",
},
],
name: "DocumentName", # required
version_name: "DocumentVersionName",
document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy
document_format: "YAML", # accepts YAML, JSON
target_type: "TargetType",
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Instance Attribute Summary collapse
-
#attachments ⇒ Array<Types::AttachmentsSource>
A list of key and value pairs that describe attachments to a version of a document.
-
#content ⇒ String
A valid JSON or YAML string.
-
#document_format ⇒ String
Specify the document format for the request.
-
#document_type ⇒ String
The type of document to create.
-
#name ⇒ String
A name for the Systems Manager document.
-
#requires ⇒ Array<Types::DocumentRequires>
A list of SSM documents required by a document.
-
#tags ⇒ Array<Types::Tag>
Optional metadata that you assign to a resource.
-
#target_type ⇒ String
Specify a target type to define the kinds of resources the document can run on.
-
#version_name ⇒ String
An optional field specifying the version of the artifact you are creating with the document.
Instance Attribute Details
#attachments ⇒ Array<Types::AttachmentsSource>
A list of key and value pairs that describe attachments to a version of a document.
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |
#content ⇒ String
A valid JSON or YAML string.
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |
#document_format ⇒ String
Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |
#document_type ⇒ String
The type of document to create. Valid document types include: ‘Command`, `Policy`, `Automation`, `Session`, and `Package`.
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |
#name ⇒ String
A name for the Systems Manager document.
Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:
* `aws`
-
‘amazon`
-
‘amzn`
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |
#requires ⇒ Array<Types::DocumentRequires>
A list of SSM documents required by a document. For example, an ‘ApplicationConfiguration` document requires an `ApplicationConfigurationSchema` document.
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:
-
‘Key=OS,Value=Windows`
-
‘Key=Environment,Value=Production`
<note markdown=“1”> To add tags to an existing SSM document, use the AddTagsToResource action.
</note>
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |
#target_type ⇒ String
Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of ‘/’ the document can run on all types of resources. If you don’t specify a value, the document can’t run on any resources. For a list of valid resource types, see [AWS Resource Types Reference] in the *AWS CloudFormation User Guide*.
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |
#version_name ⇒ String
An optional field specifying the version of the artifact you are creating with the document. For example, “Release 12, Update 6”. This value is unique across all versions of a document, and cannot be changed.
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 |
# File 'lib/aws-sdk-ssm/types.rb', line 2724 class CreateDocumentRequest < Struct.new( :content, :requires, :attachments, :name, :version_name, :document_type, :document_format, :target_type, :tags) include Aws::Structure end |