Class: AWSCDK::QLDB::CfnLedgerProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
qldb/cfn_ledger_props.rb

Overview

Properties for defining a CfnLedger.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(permissions_mode:, deletion_protection: nil, kms_key: nil, name: nil, tags: nil) ⇒ CfnLedgerProps

Returns a new instance of CfnLedgerProps.

Parameters:

  • permissions_mode (String) —

    The permissions mode to assign to the ledger that you want to create.

  • deletion_protection (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether the ledger is protected from being deleted by any user.

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

    The key in AWS Key Management Service ( AWS ) to use for encryption of data at rest in the ledger.

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

    The name of the ledger that you want to create.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'qldb/cfn_ledger_props.rb', line 14

def initialize(permissions_mode:, deletion_protection: nil, kms_key: nil, name: nil, tags: nil)
  @permissions_mode = permissions_mode
  Jsii::Type.check_type(@permissions_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "permissionsMode")
  @deletion_protection = deletion_protection
  Jsii::Type.check_type(@deletion_protection, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deletionProtection") unless @deletion_protection.nil?
  @kms_key = kms_key
  Jsii::Type.check_type(@kms_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKey") unless @kms_key.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#deletion_protection ⇒ Boolean, ... (readonly)

Specifies whether the ledger is protected from being deleted by any user.

If not defined during ledger creation, this feature is enabled ( true ) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false .

Returns:

See Also:



52
53
54
 
# File 'qldb/cfn_ledger_props.rb', line 52

def deletion_protection
  @deletion_protection
end

#kms_key ⇒ String? (readonly)

The key in AWS Key Management Service ( AWS ) to use for encryption of data at rest in the ledger.

For more information, see Encryption at rest in the Amazon QLDB Developer Guide .

Use one of the following options to specify this parameter:

  • AWS_OWNED_KMS_KEY : Use an AWS key that is owned and managed by AWS on your behalf.
  • Undefined : By default, use an AWS owned KMS key.
  • A valid symmetric customer managed KMS key : Use the specified symmetric encryption KMS key in your account that you create, own, and manage.

Amazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the AWS Key Management Service Developer Guide .

To specify a customer managed KMS key, you can use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/" . To specify a key in a different AWS account , you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Alias name: alias/ExampleAlias
  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'qldb/cfn_ledger_props.rb', line 78

def kms_key
  @kms_key
end

#name ⇒ String? (readonly)

The name of the ledger that you want to create.

The name must be unique among all of the ledgers in your AWS account in the current Region.

Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .

Returns:

  • (String, nil)

See Also:



87
88
89
 
# File 'qldb/cfn_ledger_props.rb', line 87

def name
  @name
end

#permissions_mode ⇒ String (readonly)

The permissions mode to assign to the ledger that you want to create.

This parameter can have one of the following values:

  • ALLOW_ALL : A legacy permissions mode that enables access control with API-level granularity for ledgers.

This mode allows users who have the SendCommand API permission for this ledger to run all PartiQL commands (hence, ALLOW_ALL ) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.

  • STANDARD : ( Recommended ) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.

By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the SendCommand API permission for the ledger. For information, see Getting started with the standard permissions mode in the Amazon QLDB Developer Guide .

We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger data.

Returns:

  • (String)

See Also:



43
44
45
 
# File 'qldb/cfn_ledger_props.rb', line 43

def permissions_mode
  @permissions_mode
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Returns:

See Also:



94
95
96
 
# File 'qldb/cfn_ledger_props.rb', line 94

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



96
97
98
99
100
101
102
103
104
 
# File 'qldb/cfn_ledger_props.rb', line 96

def self.jsii_properties
  {
    :permissions_mode => "permissionsMode",
    :deletion_protection => "deletionProtection",
    :kms_key => "kmsKey",
    :name => "name",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
 
# File 'qldb/cfn_ledger_props.rb', line 106

def to_jsii
  result = {}
  result.merge!({
    "permissionsMode" => @permissions_mode,
    "deletionProtection" => @deletion_protection,
    "kmsKey" => @kms_key,
    "name" => @name,
    "tags" => @tags,
  })
  result.compact
end