Interface DocumentIdentifier.Builder

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

  • Method Details

    • name

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

    • createdDate

      DocumentIdentifier.Builder createdDate(Instant createdDate)

      The date the SSM document was created.

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

    • displayName

      DocumentIdentifier.Builder displayName(String displayName)

      An optional field where you can specify a friendly name for the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

      Parameters:
      displayName - An optional field where you can specify a friendly name for 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.

    • owner

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

    • versionName

      DocumentIdentifier.Builder versionName(String versionName)

      An optional field specifying 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 - An optional field specifying 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.

    • platformTypesWithStrings

      DocumentIdentifier.Builder platformTypesWithStrings(Collection<String> platformTypes)

      The operating system platform.

      Parameters:
      platformTypes - The operating system platform.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformTypesWithStrings

      DocumentIdentifier.Builder platformTypesWithStrings(String... platformTypes)

      The operating system platform.

      Parameters:
      platformTypes - The operating system platform.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformTypes

      DocumentIdentifier.Builder platformTypes(Collection<PlatformType> platformTypes)

      The operating system platform.

      Parameters:
      platformTypes - The operating system platform.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • platformTypes

      DocumentIdentifier.Builder platformTypes(PlatformType... platformTypes)

      The operating system platform.

      Parameters:
      platformTypes - The operating system platform.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentVersion

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

    • documentType

      DocumentIdentifier.Builder documentType(String documentType)

      The document type.

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

    • documentType

      DocumentIdentifier.Builder documentType(DocumentType documentType)

      The document type.

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

    • schemaVersion

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

    • documentFormat

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

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

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

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

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

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

    • requires

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

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

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

    • reviewStatus

      DocumentIdentifier.Builder reviewStatus(String reviewStatus)

      The current status of a document review.

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

    • reviewStatus

      DocumentIdentifier.Builder reviewStatus(ReviewStatus reviewStatus)

      The current status of a document review.

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

    • author

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