Interface DocumentVersionInfo.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>, SdkBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>, SdkPojo
Enclosing class:
DocumentVersionInfo
@Mutable @NotThreadSafe public static interface DocumentVersionInfo.Builder extends SdkPojo, CopyableBuilder<DocumentVersionInfo.Builder,DocumentVersionInfo>

  • Method Details

    • name

      DocumentVersionInfo.Builder name(String name)

      The document name.

      Parameters:
      name - The document name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

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

    • documentVersion

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

    • versionName

      DocumentVersionInfo.Builder versionName(String versionName)

      The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

      Parameters:
      versionName - The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdDate

      DocumentVersionInfo.Builder createdDate(Instant createdDate)

      The date the document was created.

      Parameters:
      createdDate - The date the document was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isDefaultVersion

      DocumentVersionInfo.Builder isDefaultVersion(Boolean isDefaultVersion)

      An identifier for the default version of the document.

      Parameters:
      isDefaultVersion - An identifier for the default version of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentFormat

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

      DocumentVersionInfo.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:

    • status

      DocumentVersionInfo.Builder status(String status)

      The status of the SSM document, such as Creating, Active, Failed, and Deleting.

      Parameters:
      status - The status of the SSM document, such as Creating, Active, Failed, and Deleting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DocumentVersionInfo.Builder status(DocumentStatus status)

      The status of the SSM document, such as Creating, Active, Failed, and Deleting.

      Parameters:
      status - The status of the SSM document, such as Creating, Active, Failed, and Deleting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusInformation

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

    • reviewStatus

      DocumentVersionInfo.Builder reviewStatus(String reviewStatus)

      The current status of the approval review for the latest version of the document.

      Parameters:
      reviewStatus - The current status of the approval review for the latest version of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • reviewStatus

      DocumentVersionInfo.Builder reviewStatus(ReviewStatus reviewStatus)

      The current status of the approval review for the latest version of the document.

      Parameters:
      reviewStatus - The current status of the approval review for the latest version of the document.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: