Interface DocumentDescription.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<DocumentDescription.Builder,DocumentDescription>
,SdkBuilder<DocumentDescription.Builder,DocumentDescription>
,SdkPojo
- Enclosing class:
- DocumentDescription
public static interface DocumentDescription.Builder extends SdkPojo, CopyableBuilder<DocumentDescription.Builder,DocumentDescription>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DocumentDescription.Builder
approvedVersion(String approvedVersion)
The version of the document currently approved for use in the organization.DocumentDescription.Builder
attachmentsInformation(Collection<AttachmentInformation> attachmentsInformation)
Details about the document attachments, including names, locations, sizes, and so on.DocumentDescription.Builder
attachmentsInformation(Consumer<AttachmentInformation.Builder>... attachmentsInformation)
Details about the document attachments, including names, locations, sizes, and so on.DocumentDescription.Builder
attachmentsInformation(AttachmentInformation... attachmentsInformation)
Details about the document attachments, including names, locations, sizes, and so on.DocumentDescription.Builder
author(String author)
The user in your organization who created the document.DocumentDescription.Builder
category(String... category)
The classification of a document to help you identify and categorize its use.DocumentDescription.Builder
category(Collection<String> category)
The classification of a document to help you identify and categorize its use.DocumentDescription.Builder
categoryEnum(String... categoryEnum)
The value that identifies a document's category.DocumentDescription.Builder
categoryEnum(Collection<String> categoryEnum)
The value that identifies a document's category.DocumentDescription.Builder
createdDate(Instant createdDate)
The date when the document was created.DocumentDescription.Builder
defaultVersion(String defaultVersion)
The default version.DocumentDescription.Builder
description(String description)
A description of the document.DocumentDescription.Builder
displayName(String displayName)
The friendly name of the SSM document.DocumentDescription.Builder
documentFormat(String documentFormat)
The document format, either JSON or YAML.DocumentDescription.Builder
documentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.DocumentDescription.Builder
documentType(String documentType)
The type of document.DocumentDescription.Builder
documentType(DocumentType documentType)
The type of document.DocumentDescription.Builder
documentVersion(String documentVersion)
The document version.DocumentDescription.Builder
hash(String hash)
The Sha256 or Sha1 hash created by the system when the document was created.DocumentDescription.Builder
hashType(String hashType)
The hash type of the document.DocumentDescription.Builder
hashType(DocumentHashType hashType)
The hash type of the document.DocumentDescription.Builder
latestVersion(String latestVersion)
The latest version of the document.DocumentDescription.Builder
name(String name)
The name of the SSM document.DocumentDescription.Builder
owner(String owner)
The Amazon Web Services user that created the document.DocumentDescription.Builder
parameters(Collection<DocumentParameter> parameters)
A description of the parameters for a document.DocumentDescription.Builder
parameters(Consumer<DocumentParameter.Builder>... parameters)
A description of the parameters for a document.DocumentDescription.Builder
parameters(DocumentParameter... parameters)
A description of the parameters for a document.DocumentDescription.Builder
pendingReviewVersion(String pendingReviewVersion)
The version of the document that is currently under review.DocumentDescription.Builder
platformTypes(Collection<PlatformType> platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.DocumentDescription.Builder
platformTypes(PlatformType... platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.DocumentDescription.Builder
platformTypesWithStrings(String... platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.DocumentDescription.Builder
platformTypesWithStrings(Collection<String> platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.DocumentDescription.Builder
requires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document.DocumentDescription.Builder
requires(Consumer<DocumentRequires.Builder>... requires)
A list of SSM documents required by a document.DocumentDescription.Builder
requires(DocumentRequires... requires)
A list of SSM documents required by a document.DocumentDescription.Builder
reviewInformation(Collection<ReviewInformation> reviewInformation)
Details about the review of a document.DocumentDescription.Builder
reviewInformation(Consumer<ReviewInformation.Builder>... reviewInformation)
Details about the review of a document.DocumentDescription.Builder
reviewInformation(ReviewInformation... reviewInformation)
Details about the review of a document.DocumentDescription.Builder
reviewStatus(String reviewStatus)
The current status of the review.DocumentDescription.Builder
reviewStatus(ReviewStatus reviewStatus)
The current status of the review.DocumentDescription.Builder
schemaVersion(String schemaVersion)
The schema version.DocumentDescription.Builder
sha1(String sha1)
The SHA1 hash of the document, which you can use for verification.DocumentDescription.Builder
status(String status)
The status of the SSM document.DocumentDescription.Builder
status(DocumentStatus status)
The status of the SSM document.DocumentDescription.Builder
statusInformation(String statusInformation)
A message returned by Amazon Web Services Systems Manager that explains theStatus
value.DocumentDescription.Builder
tags(Collection<Tag> tags)
The tags, or metadata, that have been applied to the document.DocumentDescription.Builder
tags(Consumer<Tag.Builder>... tags)
The tags, or metadata, that have been applied to the document.DocumentDescription.Builder
tags(Tag... tags)
The tags, or metadata, that have been applied to the document.DocumentDescription.Builder
targetType(String targetType)
The target type which defines the kinds of resources the document can run on.DocumentDescription.Builder
versionName(String versionName)
The version of the artifact associated with the document.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
sha1
DocumentDescription.Builder sha1(String sha1)
The SHA1 hash of the document, which you can use for verification.
- Parameters:
sha1
- The SHA1 hash of the document, which you can use for verification.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hash
DocumentDescription.Builder hash(String hash)
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
- Parameters:
hash
- The Sha256 or Sha1 hash created by the system when the document was created.Sha1 hashes have been deprecated.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hashType
DocumentDescription.Builder hashType(String hashType)
The hash type of the document. Valid values include
Sha256
orSha1
.Sha1 hashes have been deprecated.
- Parameters:
hashType
- The hash type of the document. Valid values includeSha256
orSha1
.Sha1 hashes have been deprecated.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DocumentHashType
,DocumentHashType
-
hashType
DocumentDescription.Builder hashType(DocumentHashType hashType)
The hash type of the document. Valid values include
Sha256
orSha1
.Sha1 hashes have been deprecated.
- Parameters:
hashType
- The hash type of the document. Valid values includeSha256
orSha1
.Sha1 hashes have been deprecated.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DocumentHashType
,DocumentHashType
-
name
DocumentDescription.Builder name(String name)
The name of the SSM document.
- Parameters:
name
- The name of the SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayName
DocumentDescription.Builder displayName(String displayName)
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.
- Parameters:
displayName
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
versionName
DocumentDescription.Builder versionName(String versionName)
The version of the artifact associated with the document.
- Parameters:
versionName
- The version of the artifact associated with the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
owner
DocumentDescription.Builder owner(String owner)
The Amazon Web Services user that created the document.
- Parameters:
owner
- The Amazon Web Services user that created the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdDate
DocumentDescription.Builder createdDate(Instant createdDate)
The date when the document was created.
- Parameters:
createdDate
- The date when the document was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
DocumentDescription.Builder status(String status)
The status of the SSM document.
- Parameters:
status
- The status of the SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DocumentStatus
,DocumentStatus
-
status
DocumentDescription.Builder status(DocumentStatus status)
The status of the SSM document.
- Parameters:
status
- The status of the SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DocumentStatus
,DocumentStatus
-
statusInformation
DocumentDescription.Builder statusInformation(String statusInformation)
A message returned by Amazon Web Services Systems Manager that explains the
Status
value. For example, aFailed
status might be explained by theStatusInformation
message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."- Parameters:
statusInformation
- A message returned by Amazon Web Services Systems Manager that explains theStatus
value. For example, aFailed
status might be explained by theStatusInformation
message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentVersion
DocumentDescription.Builder documentVersion(String documentVersion)
The document version.
- Parameters:
documentVersion
- The document version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
DocumentDescription.Builder description(String description)
A description of the document.
- Parameters:
description
- A description of the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
DocumentDescription.Builder parameters(Collection<DocumentParameter> parameters)
A description of the parameters for a document.
- Parameters:
parameters
- A description of the parameters for a document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
DocumentDescription.Builder parameters(DocumentParameter... parameters)
A description of the parameters for a document.
- Parameters:
parameters
- A description of the parameters for a document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameters
DocumentDescription.Builder parameters(Consumer<DocumentParameter.Builder>... parameters)
A description of the parameters for a document.
This is a convenience method that creates an instance of theDocumentParameter.Builder
avoiding the need to create one manually viaDocumentParameter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#parameters(List
.) - Parameters:
parameters
- a consumer that will call methods onDocumentParameter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#parameters(java.util.Collection
)
-
platformTypesWithStrings
DocumentDescription.Builder platformTypesWithStrings(Collection<String> platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.
- Parameters:
platformTypes
- The list of operating system (OS) platforms compatible with this SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformTypesWithStrings
DocumentDescription.Builder platformTypesWithStrings(String... platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.
- Parameters:
platformTypes
- The list of operating system (OS) platforms compatible with this SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformTypes
DocumentDescription.Builder platformTypes(Collection<PlatformType> platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.
- Parameters:
platformTypes
- The list of operating system (OS) platforms compatible with this SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platformTypes
DocumentDescription.Builder platformTypes(PlatformType... platformTypes)
The list of operating system (OS) platforms compatible with this SSM document.
- Parameters:
platformTypes
- The list of operating system (OS) platforms compatible with this SSM document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentType
DocumentDescription.Builder documentType(String documentType)
The type of document.
- Parameters:
documentType
- The type of document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DocumentType
,DocumentType
-
documentType
DocumentDescription.Builder documentType(DocumentType documentType)
The type of document.
- Parameters:
documentType
- The type of document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DocumentType
,DocumentType
-
schemaVersion
DocumentDescription.Builder schemaVersion(String schemaVersion)
The schema version.
- Parameters:
schemaVersion
- The schema version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
latestVersion
DocumentDescription.Builder latestVersion(String latestVersion)
The latest version of the document.
- Parameters:
latestVersion
- The latest version of the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultVersion
DocumentDescription.Builder defaultVersion(String defaultVersion)
The default version.
- Parameters:
defaultVersion
- The default version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentFormat
DocumentDescription.Builder documentFormat(String documentFormat)
The document format, either JSON or YAML.
- Parameters:
documentFormat
- The document format, either JSON or YAML.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DocumentFormat
,DocumentFormat
-
documentFormat
DocumentDescription.Builder documentFormat(DocumentFormat documentFormat)
The document format, either JSON or YAML.
- Parameters:
documentFormat
- The document format, either JSON or YAML.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
DocumentFormat
,DocumentFormat
-
targetType
DocumentDescription.Builder targetType(String targetType)
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.- Parameters:
targetType
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
DocumentDescription.Builder tags(Collection<Tag> tags)
The tags, or metadata, that have been applied to the document.
- Parameters:
tags
- The tags, or metadata, that have been applied to the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
DocumentDescription.Builder tags(Tag... tags)
The tags, or metadata, that have been applied to the document.
- Parameters:
tags
- The tags, or metadata, that have been applied to the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
DocumentDescription.Builder tags(Consumer<Tag.Builder>... tags)
The tags, or metadata, that have been applied to the document.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
attachmentsInformation
DocumentDescription.Builder attachmentsInformation(Collection<AttachmentInformation> attachmentsInformation)
Details about the document attachments, including names, locations, sizes, and so on.
- Parameters:
attachmentsInformation
- Details about the document attachments, including names, locations, sizes, and so on.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachmentsInformation
DocumentDescription.Builder attachmentsInformation(AttachmentInformation... attachmentsInformation)
Details about the document attachments, including names, locations, sizes, and so on.
- Parameters:
attachmentsInformation
- Details about the document attachments, including names, locations, sizes, and so on.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attachmentsInformation
DocumentDescription.Builder attachmentsInformation(Consumer<AttachmentInformation.Builder>... attachmentsInformation)
Details about the document attachments, including names, locations, sizes, and so on.
This is a convenience method that creates an instance of theAttachmentInformation.Builder
avoiding the need to create one manually viaAttachmentInformation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#attachmentsInformation(List
.) - Parameters:
attachmentsInformation
- a consumer that will call methods onAttachmentInformation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#attachmentsInformation(java.util.Collection
)
-
requires
DocumentDescription.Builder requires(Collection<DocumentRequires> requires)
A list of SSM documents required by a document. For example, an
ApplicationConfiguration
document requires anApplicationConfigurationSchema
document.- Parameters:
requires
- A list of SSM documents required by a document. For example, anApplicationConfiguration
document requires anApplicationConfigurationSchema
document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requires
DocumentDescription.Builder requires(DocumentRequires... requires)
A list of SSM documents required by a document. For example, an
ApplicationConfiguration
document requires anApplicationConfigurationSchema
document.- Parameters:
requires
- A list of SSM documents required by a document. For example, anApplicationConfiguration
document requires anApplicationConfigurationSchema
document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requires
DocumentDescription.Builder requires(Consumer<DocumentRequires.Builder>... requires)
A list of SSM documents required by a document. For example, an
This is a convenience method that creates an instance of theApplicationConfiguration
document requires anApplicationConfigurationSchema
document.DocumentRequires.Builder
avoiding the need to create one manually viaDocumentRequires.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#requires(List
.) - Parameters:
requires
- a consumer that will call methods onDocumentRequires.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#requires(java.util.Collection
)
-
author
DocumentDescription.Builder author(String author)
The user in your organization who created the document.
- Parameters:
author
- The user in your organization who created the document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reviewInformation
DocumentDescription.Builder reviewInformation(Collection<ReviewInformation> reviewInformation)
Details about the review of a document.
- Parameters:
reviewInformation
- Details about the review of a document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reviewInformation
DocumentDescription.Builder reviewInformation(ReviewInformation... reviewInformation)
Details about the review of a document.
- Parameters:
reviewInformation
- Details about the review of a document.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reviewInformation
DocumentDescription.Builder reviewInformation(Consumer<ReviewInformation.Builder>... reviewInformation)
Details about the review of a document.
This is a convenience method that creates an instance of theReviewInformation.Builder
avoiding the need to create one manually viaReviewInformation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#reviewInformation(List
.) - Parameters:
reviewInformation
- a consumer that will call methods onReviewInformation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#reviewInformation(java.util.Collection
)
-
approvedVersion
DocumentDescription.Builder approvedVersion(String approvedVersion)
The version of the document currently approved for use in the organization.
- Parameters:
approvedVersion
- The version of the document currently approved for use in the organization.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pendingReviewVersion
DocumentDescription.Builder pendingReviewVersion(String pendingReviewVersion)
The version of the document that is currently under review.
- Parameters:
pendingReviewVersion
- The version of the document that is currently under review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
reviewStatus
DocumentDescription.Builder reviewStatus(String reviewStatus)
The current status of the review.
- Parameters:
reviewStatus
- The current status of the review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ReviewStatus
,ReviewStatus
-
reviewStatus
DocumentDescription.Builder reviewStatus(ReviewStatus reviewStatus)
The current status of the review.
- Parameters:
reviewStatus
- The current status of the review.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ReviewStatus
,ReviewStatus
-
category
DocumentDescription.Builder category(Collection<String> category)
The classification of a document to help you identify and categorize its use.
- Parameters:
category
- The classification of a document to help you identify and categorize its use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
category
DocumentDescription.Builder category(String... category)
The classification of a document to help you identify and categorize its use.
- Parameters:
category
- The classification of a document to help you identify and categorize its use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
categoryEnum
DocumentDescription.Builder categoryEnum(Collection<String> categoryEnum)
The value that identifies a document's category.
- Parameters:
categoryEnum
- The value that identifies a document's category.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
categoryEnum
DocumentDescription.Builder categoryEnum(String... categoryEnum)
The value that identifies a document's category.
- Parameters:
categoryEnum
- The value that identifies a document's category.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-