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

Note:

When making an API call, you may pass CreateDocumentRequest data as a hash:

{
  content: "DocumentContent", # required
  attachments: [
    {
      key: "SourceUrl", # accepts SourceUrl
      values: ["AttachmentsSourceValue"],
    },
  ],
  name: "DocumentName", # required
  version_name: "DocumentVersionName",
  document_type: "Command", # accepts Command, Policy, Automation, Session, Package
  document_format: "YAML", # accepts YAML, JSON
  target_type: "TargetType",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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.

• #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.

Returns:

• (Array<Types::AttachmentsSource>)

# File 'lib/aws-sdk-ssm/types.rb', line 2448

class CreateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_type,
  :document_format,
  :target_type)
  include Aws::Structure
end

#content ⇒ String

A valid JSON or YAML string.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2448

class CreateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_type,
  :document_format,
  :target_type)
  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.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2448

class CreateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_type,
  :document_format,
  :target_type)
  include Aws::Structure
end

#document_type ⇒ String

The type of document to create. Valid document types include: ‘Command`, `Policy`, `Automation`, `Session`, and `Package`.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2448

class CreateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_type,
  :document_format,
  :target_type)
  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`

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2448

class CreateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_type,
  :document_format,
  :target_type)
  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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2448

class CreateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_type,
  :document_format,
  :target_type)
  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.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2448

class CreateDocumentRequest < Struct.new(
  :content,
  :attachments,
  :name,
  :version_name,
  :document_type,
  :document_format,
  :target_type)
  include Aws::Structure
end