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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass CreateDocumentRequest data as a 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)


1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1805

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

#document_formatString

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

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1805

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

#document_typeString

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

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1805

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

#nameString

A name for the Systems Manager document.

Returns:

  • (String)


1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1805

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

#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)


1805
1806
1807
1808
1809
1810
1811
1812
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1805

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