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

Inherits:
Struct
  • Object
show all
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
  requires: [
    {
      name: "DocumentARN", # required
      version: "DocumentVersion",
    },
  ],
  attachments: [
    {
      key: "SourceUrl", # accepts SourceUrl, S3FileUrl, AttachmentReference
      values: ["AttachmentsSourceValue"],
      name: "AttachmentIdentifier",
    },
  ],
  name: "DocumentName", # required
  display_name: "DocumentDisplayName",
  version_name: "DocumentVersionName",
  document_type: "Command", # accepts Command, Policy, Automation, Session, Package, ApplicationConfiguration, ApplicationConfigurationSchema, DeploymentStrategy, ChangeCalendar, Automation.ChangeTemplate, ProblemAnalysis, ProblemAnalysisTemplate
  document_format: "YAML", # accepts YAML, JSON, TEXT
  target_type: "TargetType",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachmentsArray<Types::AttachmentsSource>

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

Returns:


3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#contentString

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 *Amazon Web Services Systems Manager User Guide*.

  • Create an SSM document (Amazon Web Services API)][1
  • Create an SSM document (Amazon Web Services CLI)][2
  • Create an SSM document (API)][1

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-api.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-document-cli.html

Returns:

  • (String)

3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#display_nameString

An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. You can update this value at a later time using the UpdateDocument operation.

Returns:

  • (String)

3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#document_formatString

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

Returns:

  • (String)

3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#document_typeString

The type of document to create.

Returns:

  • (String)

3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by Amazon Web Services for use as document name prefixes:

* `aws-`
  • `amazon`

  • `amzn`

Returns:

  • (String)

3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#requiresArray<Types::DocumentRequires>

A list of SSM documents required by a document. This parameter is used exclusively by 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 [What is AppConfig?] in the *AppConfig User Guide*.

[1]: docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html

Returns:


3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  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-value pairs:

  • `Key=OS,Value=Windows`

  • `Key=Environment,Value=Production`

<note markdown=“1”> To add tags to an existing SSM document, use the AddTagsToResource operation.

</note>

Returns:


3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  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 [Amazon Web Services resource and property types reference] in the *CloudFormation User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html

Returns:

  • (String)

3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  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 can't be changed.

Returns:

  • (String)

3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
# File 'lib/aws-sdk-ssm/types.rb', line 3474

class CreateDocumentRequest < Struct.new(
  :content,
  :requires,
  :attachments,
  :name,
  :display_name,
  :version_name,
  :document_type,
  :document_format,
  :target_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end