Struct rusoto_ssm::CreateDocumentRequest

pub struct CreateDocumentRequest {
    pub attachments: Option<Vec<AttachmentsSource>>,
    pub content: String,
    pub document_format: Option<String>,
    pub document_type: Option<String>,
    pub name: String,
    pub requires: Option<Vec<DocumentRequires>>,
    pub tags: Option<Vec<Tag>>,
    pub target_type: Option<String>,
    pub version_name: Option<String>,
}

Fields

attachments: Option<Vec<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.

• Create an SSM document (AWS API)

• Create an SSM document (AWS CLI)

• Create an SSM document (API)

document_format: Option<String>

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

document_type: Option<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

requires: Option<Vec<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.

tags: Option<Vec<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.

target_type: Option<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.

version_name: Option<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.

Trait Implementations

impl Clone for CreateDocumentRequest

pub fn clone(&self) -> CreateDocumentRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDocumentRequest

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateDocumentRequest

pub fn default() -> CreateDocumentRequest

Returns the "default value" for a type.

impl PartialEq<CreateDocumentRequest> for CreateDocumentRequest

pub fn eq(&self, other: &CreateDocumentRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &CreateDocumentRequest) -> bool

This method tests for !=.

impl Serialize for CreateDocumentRequest

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateDocumentRequest