Class: AWSCDK::RDS::CfnDBCluster::MasterUserSecretProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/cfn_db_cluster.rb

Overview

The MasterUserSecret return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(kms_key_id: nil, secret_arn: nil) ⇒ MasterUserSecretProperty

Returns a new instance of MasterUserSecretProperty.

Parameters:

  • kms_key_id (String, nil) (defaults to: nil)

    The AWS KMS key identifier that is used to encrypt the secret.

  • secret_arn (String, nil) (defaults to: nil)

    The Amazon Resource Name (ARN) of the secret.



1515
1516
1517
1518
1519
1520
# File 'rds/cfn_db_cluster.rb', line 1515

def initialize(kms_key_id: nil, secret_arn: nil)
  @kms_key_id = kms_key_id
  Jsii::Type.check_type(@kms_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless @kms_key_id.nil?
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn") unless @secret_arn.nil?
end

Instance Attribute Details

#kms_key_idString? (readonly)

The AWS KMS key identifier that is used to encrypt the secret.



1526
1527
1528
# File 'rds/cfn_db_cluster.rb', line 1526

def kms_key_id
  @kms_key_id
end

#secret_arnString? (readonly)

The Amazon Resource Name (ARN) of the secret.

This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values .



1533
1534
1535
# File 'rds/cfn_db_cluster.rb', line 1533

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_propertiesObject



1535
1536
1537
1538
1539
1540
# File 'rds/cfn_db_cluster.rb', line 1535

def self.jsii_properties
  {
    :kms_key_id => "kmsKeyId",
    :secret_arn => "secretArn",
  }
end

Instance Method Details

#to_jsiiObject



1542
1543
1544
1545
1546
1547
1548
1549
# File 'rds/cfn_db_cluster.rb', line 1542

def to_jsii
  result = {}
  result.merge!({
    "kmsKeyId" => @kms_key_id,
    "secretArn" => @secret_arn,
  })
  result.compact
end