Struct aws_sdk_ssm::model::document_description::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for DocumentDescription

Implementations

impl Builder

pub fn sha1(self, input: impl Into<String>) -> Self

The SHA1 hash of the document, which you can use for verification.

pub fn set_sha1(self, input: Option<String>) -> Self

The SHA1 hash of the document, which you can use for verification.

pub fn hash(self, input: impl Into<String>) -> Self

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

pub fn set_hash(self, input: Option<String>) -> Self

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

pub fn hash_type(self, input: DocumentHashType) -> Self

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

pub fn set_hash_type(self, input: Option<DocumentHashType>) -> Self

The hash type of the document. Valid values include Sha256 or Sha1.

Sha1 hashes have been deprecated.

pub fn name(self, input: impl Into<String>) -> Self

The name of the SSM document.

pub fn set_name(self, input: Option<String>) -> Self

The name of the SSM document.

pub fn display_name(self, input: impl Into<String>) -> Self

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

pub fn set_display_name(self, input: Option<String>) -> Self

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

pub fn version_name(self, input: impl Into<String>) -> Self

The version of the artifact associated with the document.

pub fn set_version_name(self, input: Option<String>) -> Self

The version of the artifact associated with the document.

pub fn owner(self, input: impl Into<String>) -> Self

The Amazon Web Services user account that created the document.

pub fn set_owner(self, input: Option<String>) -> Self

The Amazon Web Services user account that created the document.

pub fn created_date(self, input: DateTime) -> Self

The date when the document was created.

pub fn set_created_date(self, input: Option<DateTime>) -> Self

The date when the document was created.

pub fn status(self, input: DocumentStatus) -> Self

The status of the SSM document.

pub fn set_status(self, input: Option<DocumentStatus>) -> Self

The status of the SSM document.

pub fn status_information(self, input: impl Into<String>) -> Self

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

pub fn set_status_information(self, input: Option<String>) -> Self

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

pub fn document_version(self, input: impl Into<String>) -> Self

The document version.

pub fn set_document_version(self, input: Option<String>) -> Self

The document version.

pub fn description(self, input: impl Into<String>) -> Self

A description of the document.

pub fn set_description(self, input: Option<String>) -> Self

A description of the document.

pub fn parameters(self, input: DocumentParameter) -> Self

Appends an item to parameters.

To override the contents of this collection use set_parameters.

A description of the parameters for a document.

pub fn set_parameters(self, input: Option<Vec<DocumentParameter>>) -> Self

A description of the parameters for a document.

pub fn platform_types(self, input: PlatformType) -> Self

Appends an item to platform_types.

To override the contents of this collection use set_platform_types.

The list of operating system (OS) platforms compatible with this SSM document.

pub fn set_platform_types(self, input: Option<Vec<PlatformType>>) -> Self

The list of operating system (OS) platforms compatible with this SSM document.

pub fn document_type(self, input: DocumentType) -> Self

The type of document.

pub fn set_document_type(self, input: Option<DocumentType>) -> Self

The type of document.

pub fn schema_version(self, input: impl Into<String>) -> Self

The schema version.

pub fn set_schema_version(self, input: Option<String>) -> Self

The schema version.

pub fn latest_version(self, input: impl Into<String>) -> Self

The latest version of the document.

pub fn set_latest_version(self, input: Option<String>) -> Self

The latest version of the document.

pub fn default_version(self, input: impl Into<String>) -> Self

The default version.

pub fn set_default_version(self, input: Option<String>) -> Self

The default version.

pub fn document_format(self, input: DocumentFormat) -> Self

The document format, either JSON or YAML.

pub fn set_document_format(self, input: Option<DocumentFormat>) -> Self

The document format, either JSON or YAML.

pub fn target_type(self, input: impl Into<String>) -> Self

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 set_target_type(self, input: Option<String>) -> Self

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, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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

pub fn attachments_information(self, input: AttachmentInformation) -> Self

Appends an item to attachments_information.

To override the contents of this collection use set_attachments_information.

Details about the document attachments, including names, locations, sizes, and so on.

pub fn set_attachments_information(
    self,
    input: Option<Vec<AttachmentInformation>>
) -> Self

Details about the document attachments, including names, locations, sizes, and so on.

pub fn requires(self, input: DocumentRequires) -> Self

Appends an item to requires.

To override the contents of this collection use set_requires.

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

pub fn set_requires(self, input: Option<Vec<DocumentRequires>>) -> Self

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

pub fn author(self, input: impl Into<String>) -> Self

The user in your organization who created the document.

pub fn set_author(self, input: Option<String>) -> Self

The user in your organization who created the document.

pub fn review_information(self, input: ReviewInformation) -> Self

Appends an item to review_information.

To override the contents of this collection use set_review_information.

Details about the review of a document.

pub fn set_review_information(
    self,
    input: Option<Vec<ReviewInformation>>
) -> Self

Details about the review of a document.

pub fn approved_version(self, input: impl Into<String>) -> Self

The version of the document currently approved for use in the organization.

pub fn set_approved_version(self, input: Option<String>) -> Self

The version of the document currently approved for use in the organization.

pub fn pending_review_version(self, input: impl Into<String>) -> Self

The version of the document that is currently under review.

pub fn set_pending_review_version(self, input: Option<String>) -> Self

The version of the document that is currently under review.

pub fn review_status(self, input: ReviewStatus) -> Self

The current status of the review.

pub fn set_review_status(self, input: Option<ReviewStatus>) -> Self

The current status of the review.

pub fn category(self, input: impl Into<String>) -> Self

Appends an item to category.

To override the contents of this collection use set_category.

The classification of a document to help you identify and categorize its use.

pub fn set_category(self, input: Option<Vec<String>>) -> Self

The classification of a document to help you identify and categorize its use.

pub fn category_enum(self, input: impl Into<String>) -> Self

Appends an item to category_enum.

To override the contents of this collection use set_category_enum.

The value that identifies a document's category.

pub fn set_category_enum(self, input: Option<Vec<String>>) -> Self

The value that identifies a document's category.

pub fn build(self) -> DocumentDescription

Consumes the builder and constructs a DocumentDescription

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder