Package software.amazon.awssdk.services.rds.model

Class MasterUserSecret

java.lang.Object

software.amazon.awssdk.services.rds.model.MasterUserSecret

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MasterUserSecret.Builder,MasterUserSecret>

@Generated("software.amazon.awssdk:codegen")
public final class MasterUserSecret
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MasterUserSecret.Builder,MasterUserSecret>

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MasterUserSecret.Builder

Method Summary

Modifier and Type	Method	Description
static MasterUserSecret.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId()	The Amazon Web Services KMS key identifier that is used to encrypt the secret.
List<SdkField<?>>	sdkFields()
String	secretArn()	The Amazon Resource Name (ARN) of the secret.
String	secretStatus()	The status of the secret.
static Class<? extends MasterUserSecret.Builder>	serializableBuilderClass()
MasterUserSecret.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

secretArn

public final String secretArn()

The Amazon Resource Name (ARN) of the secret.

Returns:

The Amazon Resource Name (ARN) of the secret.

secretStatus

public final 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 RDS 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 DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

Returns:

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 RDS 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 DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

kmsKeyId

public final String kmsKeyId()

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

Returns:

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

toBuilder

public MasterUserSecret.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MasterUserSecret.Builder,MasterUserSecret>

builder

public static MasterUserSecret.Builder builder()

serializableBuilderClass

public static Class<? extends MasterUserSecret.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo