Struct aws_sdk_rds::types::MasterUserSecret

#[non_exhaustive]
pub struct MasterUserSecret {
    pub secret_arn: Option<String>,
    pub secret_status: Option<String>,
    pub kms_key_id: Option<String>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

secret_arn: Option<String>

The Amazon Resource Name (ARN) of the secret.

secret_status: Option<String>

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.

kms_key_id: Option<String>

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

Implementations

impl MasterUserSecret

pub fn secret_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the secret.

pub fn secret_status(&self) -> Option<&str>

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.

pub fn kms_key_id(&self) -> Option<&str>

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

impl MasterUserSecret

pub fn builder() -> MasterUserSecretBuilder

Creates a new builder-style object to manufacture MasterUserSecret.

Trait Implementations

impl Clone for MasterUserSecret

fn clone(&self) -> MasterUserSecret

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MasterUserSecret

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MasterUserSecret

fn eq(&self, other: &MasterUserSecret) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MasterUserSecret