Class CfnLedgerProps.Jsii$Proxy
- All Implemented Interfaces:
CfnLedgerProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnLedgerProps
CfnLedgerProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.qldb.CfnLedgerProps
CfnLedgerProps.Builder, CfnLedgerProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(CfnLedgerProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnLedgerProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Object
Specifies whether the ledger is protected from being deleted by any user.final String
The key in AWS Key Management Service ( AWS KMS ) to use for encryption of data at rest in the ledger.final String
getName()
The name of the ledger that you want to create.final String
The permissions mode to assign to the ledger that you want to create.getTags()
An array of key-value pairs to apply to this resource.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnLedgerProps.Builder
.
-
-
Method Details
-
getPermissionsMode
Description copied from interface:CfnLedgerProps
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.- Specified by:
getPermissionsMode
in interfaceCfnLedgerProps
-
getDeletionProtection
Description copied from interface:CfnLedgerProps
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 tofalse
.- Specified by:
getDeletionProtection
in interfaceCfnLedgerProps
-
getKmsKey
Description copied from interface:CfnLedgerProps
The key in AWS Key Management Service ( AWS KMS ) 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 KMS 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 .
- Specified by:
getKmsKey
in interfaceCfnLedgerProps
-
getName
Description copied from interface:CfnLedgerProps
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 .
- Specified by:
getName
in interfaceCfnLedgerProps
-
getTags
Description copied from interface:CfnLedgerProps
An array of key-value pairs to apply to this resource.For more information, see Tag .
- Specified by:
getTags
in interfaceCfnLedgerProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-