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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachments ⇒ Array<Types::AttachmentsSource>

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

Returns:



3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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

#content ⇒ String

The content for the new SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. 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.

Returns:

  • (String) 


3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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_name ⇒ String

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) 


3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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_format ⇒ String

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

Returns:

  • (String) 


3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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_type ⇒ String

The type of document to create.

The DeploymentStrategy document type is an internal-use-only document type reserved for AppConfig.

Returns:

  • (String) 


3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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

#name ⇒ String

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

  • AWSEC2

  • AWSConfigRemediation

  • AWSSupport

Returns:

  • (String) 


3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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

#requires ⇒ Array<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.

Returns:



3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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

#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-value pairs:

  • Key=OS,Value=Windows

  • Key=Environment,Value=Production

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

Returns:



3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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_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 Amazon Web Services resource and property types reference in the CloudFormation User Guide.

Returns:

  • (String) 


3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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_name ⇒ String

An optional field specifying the version of the artifact you are creating with the document. For example, Release12.1. This value is unique across all versions of a document, and can't be changed.

Returns:

  • (String) 


3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3431

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