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
  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, ChangeCalendar
  document_format: "YAML", # accepts YAML, JSON, TEXT
  target_type: "TargetType",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#attachmentsArray<Types::AttachmentsSource>

A list of key and value pairs that describe attachments to a version of a document.

Returns:



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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

#contentString

A valid JSON or YAML string.

Returns:

  • (String)


2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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_formatString

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

Returns:

  • (String)


2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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_typeString

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

Returns:

  • (String)


2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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

#nameString

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)


2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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

#requiresArray<Types::DocumentRequires>

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Returns:



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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

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

To add tags to an existing SSM document, use the AddTagsToResource action.

Returns:



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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_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)


2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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_nameString

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)


2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'gems/aws-sdk-ssm/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