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

Interface UpdateDocumentRequest.Builder

    • Method Detail

      • content

        UpdateDocumentRequest.Builder content​(String content)

        A valid JSON or YAML string.

        Parameters:
        content - A valid JSON or YAML string.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attachments

        UpdateDocumentRequest.Builder attachments​(Collection<AttachmentsSource> attachments)

        A list of key-value pairs that describe attachments to a version of a document.

        Parameters:
        attachments - A list of key-value pairs that describe attachments to a version of a document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attachments

        UpdateDocumentRequest.Builder attachments​(AttachmentsSource... attachments)

        A list of key-value pairs that describe attachments to a version of a document.

        Parameters:
        attachments - A list of key-value pairs that describe attachments to a version of a document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        UpdateDocumentRequest.Builder name​(String name)

        The name of the SSM document that you want to update.

        Parameters:
        name - The name of the SSM document that you want to update.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • displayName

        UpdateDocumentRequest.Builder displayName​(String displayName)

        The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.

        Parameters:
        displayName - The friendly name of the SSM document that you want to update. This value can differ for each version of the document. If you don't specify a value for this parameter in your request, the existing value is applied to the new document version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionName

        UpdateDocumentRequest.Builder versionName​(String versionName)

        An optional field specifying the version of the artifact you are updating with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

        Parameters:
        versionName - An optional field specifying the version of the artifact you are updating 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.

      • documentVersion

        UpdateDocumentRequest.Builder documentVersion​(String documentVersion)

        The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

        If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

        Parameters:
        documentVersion - The version of the document that you want to update. Currently, Systems Manager supports updating only the latest version of the document. You can specify the version number of the latest version or use the $LATEST variable.

        If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

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

      • documentFormat

        UpdateDocumentRequest.Builder documentFormat​(String documentFormat)

        Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

        Parameters:
        documentFormat - Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DocumentFormat, DocumentFormat

      • documentFormat

        UpdateDocumentRequest.Builder documentFormat​(DocumentFormat documentFormat)

        Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

        Parameters:
        documentFormat - Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DocumentFormat, DocumentFormat

      • targetType

        UpdateDocumentRequest.Builder targetType​(String targetType)

        Specify a new target type for the document.

        Parameters:
        targetType - Specify a new target type for the document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.