Struct aws_sdk_ssm::model::DocumentDescription [−][src]
#[non_exhaustive]pub struct DocumentDescription {Show 28 fields
pub sha1: Option<String>,
pub hash: Option<String>,
pub hash_type: Option<DocumentHashType>,
pub name: Option<String>,
pub display_name: Option<String>,
pub version_name: Option<String>,
pub owner: Option<String>,
pub created_date: Option<Instant>,
pub status: Option<DocumentStatus>,
pub status_information: Option<String>,
pub document_version: Option<String>,
pub description: Option<String>,
pub parameters: Option<Vec<DocumentParameter>>,
pub platform_types: Option<Vec<PlatformType>>,
pub document_type: Option<DocumentType>,
pub schema_version: Option<String>,
pub latest_version: Option<String>,
pub default_version: Option<String>,
pub document_format: Option<DocumentFormat>,
pub target_type: Option<String>,
pub tags: Option<Vec<Tag>>,
pub attachments_information: Option<Vec<AttachmentInformation>>,
pub requires: Option<Vec<DocumentRequires>>,
pub author: Option<String>,
pub review_information: Option<Vec<ReviewInformation>>,
pub approved_version: Option<String>,
pub pending_review_version: Option<String>,
pub review_status: Option<ReviewStatus>,
}
Expand description
Describes a Amazon Web Services Systems Manager document (SSM document).
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.sha1: Option<String>
The SHA1 hash of the document, which you can use for verification.
hash: Option<String>
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
hash_type: Option<DocumentHashType>
The hash type of the document. Valid values include Sha256
or
Sha1
.
Sha1 hashes have been deprecated.
name: Option<String>
The name of the SSM document.
display_name: Option<String>
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.
version_name: Option<String>
The version of the artifact associated with the document.
owner: Option<String>
The Amazon Web Services user account that created the document.
created_date: Option<Instant>
The date when the document was created.
status: Option<DocumentStatus>
The status of the SSM document.
status_information: Option<String>
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."
document_version: Option<String>
The document version.
description: Option<String>
A description of the document.
parameters: Option<Vec<DocumentParameter>>
A description of the parameters for a document.
platform_types: Option<Vec<PlatformType>>
The list of OS platforms compatible with this SSM document.
document_type: Option<DocumentType>
The type of document.
schema_version: Option<String>
The schema version.
latest_version: Option<String>
The latest version of the document.
default_version: Option<String>
The default 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.
The tags, or metadata, that have been applied to the document.
attachments_information: Option<Vec<AttachmentInformation>>
Details about the document attachments, including names, locations, sizes, and so on.
requires: Option<Vec<DocumentRequires>>
A list of SSM documents required by a document. For example, an
ApplicationConfiguration
document requires an
ApplicationConfigurationSchema
document.
The user in your organization who created the document.
review_information: Option<Vec<ReviewInformation>>
Details about the review of a document.
approved_version: Option<String>
The version of the document currently approved for use in the organization.
pending_review_version: Option<String>
The version of the document that is currently under review.
review_status: Option<ReviewStatus>
The current status of the review.
Implementations
The SHA1 hash of the document, which you can use for verification.
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
The hash type of the document. Valid values include Sha256
or
Sha1
.
Sha1 hashes have been deprecated.
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.
The version of the artifact associated with the document.
The Amazon Web Services user account that created the document.
The date when the document was created.
The status of the SSM document.
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."
The document version.
A description of the document.
A description of the parameters for a document.
The list of OS platforms compatible with this SSM document.
The type of document.
The schema version.
The latest version of the document.
The default version.
The document format, either JSON or YAML.
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.
The tags, or metadata, that have been applied to the document.
Details about the document attachments, including names, locations, sizes, and so on.
A list of SSM documents required by a document. For example, an
ApplicationConfiguration
document requires an
ApplicationConfigurationSchema
document.
The user in your organization who created the document.
Details about the review of a document.
The version of the document currently approved for use in the organization.
The version of the document that is currently under review.
The current status of the review.
Creates a new builder-style object to manufacture DocumentDescription
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for DocumentDescription
impl Send for DocumentDescription
impl Sync for DocumentDescription
impl Unpin for DocumentDescription
impl UnwindSafe for DocumentDescription
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more