Package software.amazon.awssdk.services.ssm.model

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 Details

    • 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 or Sha1.

      Sha1 hashes have been deprecated.

      Parameters:
      hashType - The hash type of the document. Valid values include Sha256 or Sha1.

      Sha1 hashes have been deprecated.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hashType

      DocumentDescription.Builder hashType(DocumentHashType hashType)

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

      Sha1 hashes have been deprecated.

      Parameters:
      hashType - The hash type of the document. Valid values include Sha256 or Sha1.

      Sha1 hashes have been deprecated.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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:

    • 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:

    • statusInformation

      DocumentDescription.Builder statusInformation(String statusInformation)

      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."

      Parameters:
      statusInformation - 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."
      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 the DocumentParameter.Builder avoiding the need to create one manually via DocumentParameter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(List<DocumentParameter>).

      Parameters:
      parameters - a consumer that will call methods on DocumentParameter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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:

    • 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

      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:

    • 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 the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the AttachmentInformation.Builder avoiding the need to create one manually via AttachmentInformation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachmentsInformation(List<AttachmentInformation>).

      Parameters:
      attachmentsInformation - a consumer that will call methods on AttachmentInformation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requires

      DocumentDescription.Builder requires(Collection<DocumentRequires> requires)

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

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

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

      This is a convenience method that creates an instance of the DocumentRequires.Builder avoiding the need to create one manually via DocumentRequires.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requires(List<DocumentRequires>).

      Parameters:
      requires - a consumer that will call methods on DocumentRequires.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the ReviewInformation.Builder avoiding the need to create one manually via ReviewInformation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reviewInformation(List<ReviewInformation>).

      Parameters:
      reviewInformation - a consumer that will call methods on ReviewInformation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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:

    • 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.