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
  requires: [
    {
      name: "DocumentARN", # required
      version: "DocumentVersion",
    },
  ],
  attachments: [
    {
      key: "SourceUrl", # accepts SourceUrl, S3FileUrl, AttachmentReference
      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
    },
  ],
}

See Also:

Instance Attribute Summary collapse

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

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

#content ⇒ String

The content for the new SSM document in JSON or YAML format. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

For examples, see the following topics in the AWS Systems Manager User Guide.

Returns:

  • (String) —

    The content for the new SSM document in JSON or YAML format.

#document_format ⇒ String

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

Possible values:

  • YAML
  • JSON
  • TEXT

Returns:

  • (String) —

    Specify the document format for the request.

#document_type ⇒ String

The type of document to create.

Possible values:

  • Command
  • Policy
  • Automation
  • Session
  • Package
  • ApplicationConfiguration
  • ApplicationConfigurationSchema
  • DeploymentStrategy
  • ChangeCalendar

Returns:

  • (String) —

    The type of document to create.

#name ⇒ String

A name for the Systems Manager document.

You can\'t use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:

  • aws-

  • amazon

  • amzn

Returns:

  • (String) —

    A name for the Systems Manager document.

#requires ⇒ Array<Types::DocumentRequires>

A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig. When a user creates an AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see AWS AppConfig in the AWS Systems Manager User Guide.

Returns:

#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

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

Returns:

  • (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. 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 and property 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.

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

    An optional field specifying the version of the artifact you are creating with the document.