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

Class: Aws::SSM::Types::CreateDocumentRequest

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

Overview

Note:

When passing CreateDocumentRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  content: "DocumentContent", # required
  name: "DocumentName", # required
  document_type: "Command", # accepts Command, Policy, Automation
  document_format: "YAML", # accepts YAML, JSON
  target_type: "TargetType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#contentString

A valid JSON or YAML string.

Returns:

  • (String)

    A valid JSON or YAML string.

#document_formatString

Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.

Possible values:

  • YAML
  • JSON

Returns:

  • (String)

    Specify the document format for the request.

#document_typeString

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

Possible values:

  • Command
  • Policy
  • Automation

Returns:

  • (String)

    The type of document to create.

#nameString

A name for the Systems Manager document.

Returns:

  • (String)

    A name for the Systems Manager document.

#target_typeString

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.

Returns:

  • (String)

    Specify a target type to define the kinds of resources the document can run on.