Class: AWSCDK::RDS::CfnDBInstance::MasterUserSecretProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
rds/cfn_db_instance.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.



2169
2170
2171
2172
2173
2174
# File 'rds/cfn_db_instance.rb', line 2169

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.



2180
2181
2182
# File 'rds/cfn_db_instance.rb', line 2180

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 .



2187
2188
2189
# File 'rds/cfn_db_instance.rb', line 2187

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_propertiesObject



2189
2190
2191
2192
2193
2194
# File 'rds/cfn_db_instance.rb', line 2189

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

Instance Method Details

#to_jsiiObject



2196
2197
2198
2199
2200
2201
2202
2203
# File 'rds/cfn_db_instance.rb', line 2196

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