Class: Aws::RDS::Types::MasterUserSecret

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

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][2

in

the *Amazon Aurora User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#kms_key_idString

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

Returns:

  • (String)


16278
16279
16280
16281
16282
16283
16284
# File 'lib/aws-sdk-rds/types.rb', line 16278

class MasterUserSecret < Struct.new(
  :secret_arn,
  :secret_status,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

The Amazon Resource Name (ARN) of the secret.

Returns:

  • (String)


16278
16279
16280
16281
16282
16283
16284
# File 'lib/aws-sdk-rds/types.rb', line 16278

class MasterUserSecret < Struct.new(
  :secret_arn,
  :secret_status,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#secret_statusString

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:

  • (String)


16278
16279
16280
16281
16282
16283
16284
# File 'lib/aws-sdk-rds/types.rb', line 16278

class MasterUserSecret < Struct.new(
  :secret_arn,
  :secret_status,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end