Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/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 in the Amazon Aurora User Guide.

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)

17282
17283
17284
17285
17286
17287
17288
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17282

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)

17282
17283
17284
17285
17286
17287
17288
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17282

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)

17282
17283
17284
17285
17286
17287
17288
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 17282

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