| Package | Description |
|---|---|
| com.amazonaws.services.simplesystemsmanagement.model |
| Modifier and Type | Method and Description |
|---|---|
DocumentDescription |
DocumentDescription.clone() |
DocumentDescription |
DescribeDocumentResult.getDocument()
Information about the SSM document.
|
DocumentDescription |
CreateDocumentResult.getDocumentDescription()
Information about the SSM document.
|
DocumentDescription |
UpdateDocumentResult.getDocumentDescription()
A description of the document that was updated.
|
DocumentDescription |
DocumentDescription.withApprovedVersion(String approvedVersion)
The version of the document currently approved for use in the organization.
|
DocumentDescription |
DocumentDescription.withAttachmentsInformation(AttachmentInformation... attachmentsInformation)
Details about the document attachments, including names, locations, sizes, and so on.
|
DocumentDescription |
DocumentDescription.withAttachmentsInformation(Collection<AttachmentInformation> attachmentsInformation)
Details about the document attachments, including names, locations, sizes, and so on.
|
DocumentDescription |
DocumentDescription.withAuthor(String author)
The user in your organization who created the document.
|
DocumentDescription |
DocumentDescription.withCategory(Collection<String> category)
The classification of a document to help you identify and categorize its use.
|
DocumentDescription |
DocumentDescription.withCategory(String... category)
The classification of a document to help you identify and categorize its use.
|
DocumentDescription |
DocumentDescription.withCategoryEnum(Collection<String> categoryEnum)
The value that identifies a document's category.
|
DocumentDescription |
DocumentDescription.withCategoryEnum(String... categoryEnum)
The value that identifies a document's category.
|
DocumentDescription |
DocumentDescription.withCreatedDate(Date createdDate)
The date when the document was created.
|
DocumentDescription |
DocumentDescription.withDefaultVersion(String defaultVersion)
The default version.
|
DocumentDescription |
DocumentDescription.withDescription(String description)
A description of the document.
|
DocumentDescription |
DocumentDescription.withDisplayName(String displayName)
The friendly name of the SSM document.
|
DocumentDescription |
DocumentDescription.withDocumentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.
|
DocumentDescription |
DocumentDescription.withDocumentFormat(String documentFormat)
The document format, either JSON or YAML.
|
DocumentDescription |
DocumentDescription.withDocumentType(DocumentType documentType)
The type of document.
|
DocumentDescription |
DocumentDescription.withDocumentType(String documentType)
The type of document.
|
DocumentDescription |
DocumentDescription.withDocumentVersion(String documentVersion)
The document version.
|
DocumentDescription |
DocumentDescription.withHash(String hash)
The Sha256 or Sha1 hash created by the system when the document was created.
|
DocumentDescription |
DocumentDescription.withHashType(DocumentHashType hashType)
The hash type of the document.
|
DocumentDescription |
DocumentDescription.withHashType(String hashType)
The hash type of the document.
|
DocumentDescription |
DocumentDescription.withLatestVersion(String latestVersion)
The latest version of the document.
|
DocumentDescription |
DocumentDescription.withName(String name)
The name of the SSM document.
|
DocumentDescription |
DocumentDescription.withOwner(String owner)
The Amazon Web Services user that created the document.
|
DocumentDescription |
DocumentDescription.withParameters(Collection<DocumentParameter> parameters)
A description of the parameters for a document.
|
DocumentDescription |
DocumentDescription.withParameters(DocumentParameter... parameters)
A description of the parameters for a document.
|
DocumentDescription |
DocumentDescription.withPendingReviewVersion(String pendingReviewVersion)
The version of the document that is currently under review.
|
DocumentDescription |
DocumentDescription.withPlatformTypes(Collection<String> platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.
|
DocumentDescription |
DocumentDescription.withPlatformTypes(PlatformType... platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.
|
DocumentDescription |
DocumentDescription.withPlatformTypes(String... platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.
|
DocumentDescription |
DocumentDescription.withRequires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document.
|
DocumentDescription |
DocumentDescription.withRequires(DocumentRequires... requires)
A list of SSM documents required by a document.
|
DocumentDescription |
DocumentDescription.withReviewInformation(Collection<ReviewInformation> reviewInformation)
Details about the review of a document.
|
DocumentDescription |
DocumentDescription.withReviewInformation(ReviewInformation... reviewInformation)
Details about the review of a document.
|
DocumentDescription |
DocumentDescription.withReviewStatus(ReviewStatus reviewStatus)
The current status of the review.
|
DocumentDescription |
DocumentDescription.withReviewStatus(String reviewStatus)
The current status of the review.
|
DocumentDescription |
DocumentDescription.withSchemaVersion(String schemaVersion)
The schema version.
|
DocumentDescription |
DocumentDescription.withSha1(String sha1)
The SHA1 hash of the document, which you can use for verification.
|
DocumentDescription |
DocumentDescription.withStatus(DocumentStatus status)
The status of the SSM document.
|
DocumentDescription |
DocumentDescription.withStatus(String status)
The status of the SSM document.
|
DocumentDescription |
DocumentDescription.withStatusInformation(String statusInformation)
A message returned by Amazon Web Services Systems Manager that explains the
Status value. |
DocumentDescription |
DocumentDescription.withTags(Collection<Tag> tags)
The tags, or metadata, that have been applied to the document.
|
DocumentDescription |
DocumentDescription.withTags(Tag... tags)
The tags, or metadata, that have been applied to the document.
|
DocumentDescription |
DocumentDescription.withTargetType(String targetType)
The target type which defines the kinds of resources the document can run on.
|
DocumentDescription |
DocumentDescription.withVersionName(String versionName)
The version of the artifact associated with the document.
|
| Modifier and Type | Method and Description |
|---|---|
void |
DescribeDocumentResult.setDocument(DocumentDescription document)
Information about the SSM document.
|
void |
CreateDocumentResult.setDocumentDescription(DocumentDescription documentDescription)
Information about the SSM document.
|
void |
UpdateDocumentResult.setDocumentDescription(DocumentDescription documentDescription)
A description of the document that was updated.
|
DescribeDocumentResult |
DescribeDocumentResult.withDocument(DocumentDescription document)
Information about the SSM document.
|
CreateDocumentResult |
CreateDocumentResult.withDocumentDescription(DocumentDescription documentDescription)
Information about the SSM document.
|
UpdateDocumentResult |
UpdateDocumentResult.withDocumentDescription(DocumentDescription documentDescription)
A description of the document that was updated.
|
Copyright © 2023. All rights reserved.