Interface ClusterMasterUserSecret.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ClusterMasterUserSecret.Builder,ClusterMasterUserSecret>, SdkBuilder<ClusterMasterUserSecret.Builder,ClusterMasterUserSecret>, SdkPojo

Enclosing class:

ClusterMasterUserSecret

@Mutable
@NotThreadSafe
public static interface ClusterMasterUserSecret.Builder
extends SdkPojo, CopyableBuilder<ClusterMasterUserSecret.Builder,ClusterMasterUserSecret>

Method Summary

Modifier and Type	Method	Description
ClusterMasterUserSecret.Builder	kmsKeyId(String kmsKeyId)	The Amazon Web Services KMS key identifier that is used to encrypt the secret.
ClusterMasterUserSecret.Builder	secretArn(String secretArn)	The Amazon Resource Name (ARN) of the secret.
ClusterMasterUserSecret.Builder	secretStatus(String secretStatus)	The status of the secret.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

secretArn

ClusterMasterUserSecret.Builder secretArn(String secretArn)

The Amazon Resource Name (ARN) of the secret.

Parameters:

secretArn - The Amazon Resource Name (ARN) of the secret.

Returns:

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

secretStatus

ClusterMasterUserSecret.Builder secretStatus(String secretStatus)

The status of the secret.

The possible status values include the following:

• creating - The secret is being created.

• active - The secret is available for normal use and rotation.

• rotating - The secret is being rotated.

• impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret.

  When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.

Parameters:

secretStatus - The status of the secret.

The possible status values include the following:

• creating - The secret is being created.

• active - The secret is available for normal use and rotation.

• rotating - The secret is being rotated.

• impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret.

  When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.

Returns:

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

kmsKeyId

ClusterMasterUserSecret.Builder kmsKeyId(String kmsKeyId)

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

Parameters:

kmsKeyId - The Amazon Web Services KMS key identifier that is used to encrypt the secret.

Returns:

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