Class: AWSCDK::DocDB::DatabaseSecretProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
doc_db/database_secret_props.rb

Overview

Construction properties for a DatabaseSecret.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username:, encryption_key: nil, exclude_characters: nil, master_secret: nil, secret_name: nil) ⇒ DatabaseSecretProps

Returns a new instance of DatabaseSecretProps.

Parameters:

  • username (String) —

    The username.

  • encryption_key (AWSCDK::KMS::IKey, nil) (defaults to: nil) —

    The KMS key to use to encrypt the secret.

  • exclude_characters (String, nil) (defaults to: nil) —

    Characters to not include in the generated password.

  • master_secret (AWSCDK::SecretsManager::ISecret, nil) (defaults to: nil) —

    The master secret which will be used to rotate this secret.

  • secret_name (String, nil) (defaults to: nil) —

    The physical name of the secret.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'doc_db/database_secret_props.rb', line 12

def initialize(username:, encryption_key: nil, exclude_characters: nil, master_secret: nil, secret_name: nil)
  @username = username
  Jsii::Type.check_type(@username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "username")
  @encryption_key = encryption_key
  Jsii::Type.check_type(@encryption_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "encryptionKey") unless @encryption_key.nil?
  @exclude_characters = exclude_characters
  Jsii::Type.check_type(@exclude_characters, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "excludeCharacters") unless @exclude_characters.nil?
  @master_secret = master_secret
  Jsii::Type.check_type(@master_secret, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjcmV0c21hbmFnZXIuSVNlY3JldCJ9")), "masterSecret") unless @master_secret.nil?
  @secret_name = secret_name
  Jsii::Type.check_type(@secret_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretName") unless @secret_name.nil?
end

Instance Attribute Details

#encryption_key ⇒ AWSCDK::KMS::IKey? (readonly)

Note:

Default: default master key

The KMS key to use to encrypt the secret.

Returns:



33
34
35
 
# File 'doc_db/database_secret_props.rb', line 33

def encryption_key
  @encryption_key
end

#exclude_characters ⇒ String? (readonly)

Note:

Default: "\"@/"

Characters to not include in the generated password.

Returns:

  • (String, nil) 


38
39
40
 
# File 'doc_db/database_secret_props.rb', line 38

def exclude_characters
  @exclude_characters
end

#master_secret ⇒ AWSCDK::SecretsManager::ISecret? (readonly)

Note:

Default: - no master secret information will be included

The master secret which will be used to rotate this secret.

Returns:



43
44
45
 
# File 'doc_db/database_secret_props.rb', line 43

def master_secret
  @master_secret
end

#secret_name ⇒ String? (readonly)

Note:

Default: Secretsmanager will generate a physical name for the secret

The physical name of the secret.

Returns:

  • (String, nil) 


48
49
50
 
# File 'doc_db/database_secret_props.rb', line 48

def secret_name
  @secret_name
end

#username ⇒ String (readonly)

The username.

Returns:

  • (String) 


28
29
30
 
# File 'doc_db/database_secret_props.rb', line 28

def username
  @username
end

Class Method Details

.jsii_properties ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'doc_db/database_secret_props.rb', line 50

def self.jsii_properties
  {
    :username => "username",
    :encryption_key => "encryptionKey",
    :exclude_characters => "excludeCharacters",
    :master_secret => "masterSecret",
    :secret_name => "secretName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
 
# File 'doc_db/database_secret_props.rb', line 60

def to_jsii
  result = {}
  result.merge!({
    "username" => @username,
    "encryptionKey" => @encryption_key,
    "excludeCharacters" => @exclude_characters,
    "masterSecret" => @master_secret,
    "secretName" => @secret_name,
  })
  result.compact
end