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

Interface DocumentDescription.Builder

All Superinterfaces:

CopyableBuilder<DocumentDescription.Builder,DocumentDescription>, SdkBuilder<DocumentDescription.Builder,DocumentDescription>

Enclosing class:

DocumentDescription

public static interface DocumentDescription.Builder
extends CopyableBuilder<DocumentDescription.Builder,DocumentDescription>

Method Summary

Modifier and Type	Method	Description
DocumentDescription.Builder	createdDate(Date 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	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)	Sha256 or Sha1.
DocumentDescription.Builder	hashType(DocumentHashType hashType)	Sha256 or Sha1.
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 AWS user account of the person who created the document.
DocumentDescription.Builder	parameters(Collection<DocumentParameter> parameters)	A description of the parameters for a document.
DocumentDescription.Builder	parameters(DocumentParameter... parameters)	A description of the parameters for a document.
DocumentDescription.Builder	platformTypes(String... platformTypes)	The list of OS platforms compatible with this SSM document.
DocumentDescription.Builder	platformTypes(Collection<String> platformTypes)	The list of OS platforms compatible with this SSM document.
DocumentDescription.Builder	platformTypes(PlatformType... platformTypes)	The list of OS platforms compatible with this SSM document.
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 purposes.
DocumentDescription.Builder	status(String status)	The status of the SSM document.
DocumentDescription.Builder	status(DocumentStatus status)	The status of the SSM document.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

sha1

DocumentDescription.Builder sha1(String sha1)

The SHA1 hash of the document, which you can use for verification purposes.

Parameters:

sha1 - The SHA1 hash of the document, which you can use for verification purposes.

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)

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Parameters:

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

DocumentHashType

hashType

DocumentDescription.Builder hashType(DocumentHashType hashType)

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Parameters:

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

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.

owner

DocumentDescription.Builder owner(String owner)

The AWS user account of the person who created the document.

Parameters:

owner - The AWS user account of the person who created the document.

Returns:

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

createdDate

DocumentDescription.Builder createdDate(Date 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

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

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.

NOTE: This method appends the values to the existing list (if any). Use #setParameters(java.util.Collection) or #withParameters(java.util.Collection) if you want to override the existing values.

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.

platformTypes

DocumentDescription.Builder platformTypes(Collection<String> platformTypes)

The list of OS platforms compatible with this SSM document.

Parameters:

platformTypes - The list of OS platforms compatible with this SSM document.

Returns:

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

See Also:

PlatformType

platformTypes

DocumentDescription.Builder platformTypes(String... platformTypes)

The list of OS platforms compatible with this SSM document.

NOTE: This method appends the values to the existing list (if any). Use #setPlatformTypes(java.util.Collection) or #withPlatformTypes(java.util.Collection) if you want to override the existing values.

Parameters:

platformTypes - The list of OS platforms compatible with this SSM document.

Returns:

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

See Also:

PlatformType

platformTypes

DocumentDescription.Builder platformTypes(PlatformType... platformTypes)

The list of OS platforms compatible with this SSM document.

NOTE: This method appends the values to the existing list (if any). Use #setPlatformTypes(java.util.Collection) or #withPlatformTypes(java.util.Collection) if you want to override the existing values.

Parameters:

platformTypes - The list of OS platforms compatible with this SSM document.

Returns:

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

See Also:

PlatformType

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

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

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.