Struct aws_sdk_ssm::operation::update_document::UpdateDocumentInput

#[non_exhaustive]
pub struct UpdateDocumentInput {
    pub content: Option<String>,
    pub attachments: Option<Vec<AttachmentsSource>>,
    pub name: Option<String>,
    pub display_name: Option<String>,
    pub version_name: Option<String>,
    pub document_version: Option<String>,
    pub document_format: Option<DocumentFormat>,
    pub target_type: Option<String>,
}

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>

A valid JSON or YAML string.

attachments: Option<Vec<AttachmentsSource>>

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

name: Option<String>

The name of the SSM document that you want to update.

display_name: Option<String>

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

version_name: Option<String>

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

document_version: Option<String>

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

document_format: Option<DocumentFormat>

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

target_type: Option<String>

Specify a new target type for the document.

Implementations

impl UpdateDocumentInput

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

A valid JSON or YAML string.

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>

The name of the SSM document that you want to update.

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

The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

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

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

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

The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

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

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

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

Specify a new target type for the document.

impl UpdateDocumentInput

pub fn builder() -> UpdateDocumentInputBuilder

Creates a new builder-style object to manufacture UpdateDocumentInput.

Trait Implementations

impl Clone for UpdateDocumentInput

fn clone(&self) -> UpdateDocumentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateDocumentInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateDocumentInput

fn eq(&self, other: &UpdateDocumentInput) -> 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 UpdateDocumentInput