Struct DocumentIdentifier

#[non_exhaustive]
pub struct DocumentIdentifier {

    pub name: Option<String>,
    pub created_date: Option<DateTime>,
    pub display_name: Option<String>,
    pub owner: Option<String>,
    pub version_name: Option<String>,
    pub platform_types: Option<Vec<PlatformType>>,
    pub document_version: Option<String>,
    pub document_type: Option<DocumentType>,
    pub schema_version: Option<String>,
    pub document_format: Option<DocumentFormat>,
    pub target_type: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub requires: Option<Vec<DocumentRequires>>,
    pub review_status: Option<ReviewStatus>,
    pub author: Option<String>,
}

Describes the name of a SSM document.

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.

name: Option<String>

The name of the SSM document.

created_date: Option<DateTime>

The date the SSM document was created.

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. If you want to update this value, see UpdateDocument.

owner: Option<String>

The Amazon Web Services user that created the document.

version_name: Option<String>

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

platform_types: Option<Vec<PlatformType>>

The operating system platform.

document_version: Option<String>

The document version.

document_type: Option<DocumentType>

The document type.

schema_version: Option<String>

The schema version.

document_format: Option<DocumentFormat>

The document format, either JSON or YAML.

target_type: Option<String>

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. 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>>

The tags, or metadata, that have been applied to the document.

requires: Option<Vec<DocumentRequires>>

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

review_status: Option<ReviewStatus>

The current status of a document review.

author: Option<String>

The user in your organization who created the document.

Implementations

impl DocumentIdentifier

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

The name of the SSM document.

pub fn created_date(&self) -> Option<&DateTime>

The date the SSM document was created.

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. If you want to update this value, see UpdateDocument.

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

The Amazon Web Services user that created the document.

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

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

pub fn platform_types(&self) -> &[PlatformType]

The operating system platform.

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

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

The document version.

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

The document type.

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

The schema version.

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

The document format, either JSON or YAML.

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

The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. 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]

The tags, or metadata, that have been applied to the 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 .tags.is_none().

pub fn requires(&self) -> &[DocumentRequires]

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema 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 .requires.is_none().

pub fn review_status(&self) -> Option<&ReviewStatus>

The current status of a document review.

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

The user in your organization who created the document.

impl DocumentIdentifier

pub fn builder() -> DocumentIdentifierBuilder

Creates a new builder-style object to manufacture DocumentIdentifier.

Trait Implementations

impl Clone for DocumentIdentifier

fn clone(&self) -> DocumentIdentifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentIdentifier

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

Formats the value using the given formatter.

impl PartialEq for DocumentIdentifier

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DocumentIdentifier