Struct aws_sdk_ssm::operation::create_document::CreateDocumentInput

#[non_exhaustive]
pub struct CreateDocumentInput {
    pub content: Option<String>,
    pub requires: Option<Vec<DocumentRequires>>,
    pub attachments: Option<Vec<AttachmentsSource>>,
    pub name: Option<String>,
    pub display_name: Option<String>,
    pub version_name: Option<String>,
    pub document_type: Option<DocumentType>,
    pub document_format: Option<DocumentFormat>,
    pub target_type: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

• Create an SSM document (console)

• Create an SSM document (command line)

• Create an SSM document (API)

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

attachments: Option<Vec<AttachmentsSource>>

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

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

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

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

document_type: Option<DocumentType>

The type of document to create.

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

document_format: Option<DocumentFormat>

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

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 Amazon Web Services resource and property types reference in the CloudFormation 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-value pairs:

• Key=OS,Value=Windows

• Key=Environment,Value=Production

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

Implementations

impl CreateDocumentInput

pub fn content(&self) -> Option<&str>

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.

• Create an SSM document (console)

• Create an SSM document (command line)

• Create an SSM document (API)

pub fn requires(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .requires.is_none().

pub fn attachments(&self) -> &[AttachmentsSource]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attachments.is_none().

pub fn name(&self) -> Option<&str>

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

pub fn display_name(&self) -> Option<&str>

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.

pub fn version_name(&self) -> Option<&str>

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.

pub fn document_type(&self) -> Option<&DocumentType>

The type of document to create.

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

pub fn document_format(&self) -> Option<&DocumentFormat>

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

pub fn target_type(&self) -> Option<&str>

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.

pub fn tags(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateDocumentInput

pub fn builder() -> CreateDocumentInputBuilder

Creates a new builder-style object to manufacture CreateDocumentInput.

Trait Implementations

impl Clone for CreateDocumentInput

fn clone(&self) -> CreateDocumentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateDocumentInput

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

Formats the value using the given formatter.

impl PartialEq for CreateDocumentInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDocumentInput