class Amazonite::Ssm::CreateDocumentRequest

Included Modules

Defined in:

ssm/create_document_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(content : String, name : String, requires : Array(DocumentRequires) | Nil = nil, attachments : Array(AttachmentsSource) | Nil = nil, display_name : String | Nil = nil, version_name : String | Nil = nil, document_type : DocumentType | Nil = nil, document_format : DocumentFormat | Nil = nil, target_type : String | Nil = nil, tags : Array(Tag) | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def attachments : Array(AttachmentsSource) | Nil #

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


[View source]
def attachments=(attachments : Array(AttachmentsSource) | Nil) #

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


[View source]
def 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.


[View source]
def content=(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.


[View source]
def display_name : String | Nil #

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.


[View source]
def display_name=(display_name : String | Nil) #

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.


[View source]
def document_format : DocumentFormat | Nil #

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


[View source]
def document_format=(document_format : DocumentFormat | Nil) #

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


[View source]
def document_type : DocumentType | Nil #

The type of document to create.

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


[View source]
def document_type=(document_type : DocumentType | Nil) #

The type of document to create.

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def 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


[View source]
def name=(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


[View source]
def requires : Array(DocumentRequires) | Nil #

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.


[View source]
def requires=(requires : Array(DocumentRequires) | Nil) #

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.


[View source]
def tags : Array(Tag) | Nil #

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.


[View source]
def tags=(tags : Array(Tag) | Nil) #

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.


[View source]
def target_type : String | Nil #

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.


[View source]
def target_type=(target_type : String | Nil) #

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.


[View source]
def validate! : Nil #

[View source]
def version_name : String | Nil #

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.


[View source]
def version_name=(version_name : String | Nil) #

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.


[View source]