@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:52.385Z") public class CfnLedger extends CfnResource implements IInspectable
The AWS::QLDB::Ledger
resource specifies a new Amazon Quantum Ledger Database (Amazon QLDB) ledger in your AWS account . Amazon QLDB is a fully managed ledger database that provides a transparent, immutable, and cryptographically verifiable transaction log owned by a central trusted authority. You can use QLDB to track all application data changes, and maintain a complete and verifiable history of changes over time.
For more information, see CreateLedger in the Amazon QLDB API Reference .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.qldb.*; CfnLedger cfnLedger = CfnLedger.Builder.create(this, "MyCfnLedger") .permissionsMode("permissionsMode") // the properties below are optional .deletionProtection(false) .kmsKey("kmsKey") .name("name") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnLedger.Builder
A fluent builder for
CfnLedger . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnLedger(Construct scope,
java.lang.String id,
CfnLedgerProps props)
Create a new `AWS::QLDB::Ledger`.
|
protected |
CfnLedger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnLedger(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDeletionProtection()
Specifies whether the ledger is protected from being deleted by any user.
|
java.lang.String |
getKmsKey()
The key in AWS Key Management Service ( AWS KMS ) to use for encryption of data at rest in the ledger.
|
java.lang.String |
getName()
The name of the ledger that you want to create.
|
java.lang.String |
getPermissionsMode()
The permissions mode to assign to the ledger that you want to create.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDeletionProtection(java.lang.Boolean value)
Specifies whether the ledger is protected from being deleted by any user.
|
void |
setDeletionProtection(IResolvable value)
Specifies whether the ledger is protected from being deleted by any user.
|
void |
setKmsKey(java.lang.String value)
The key in AWS Key Management Service ( AWS KMS ) to use for encryption of data at rest in the ledger.
|
void |
setName(java.lang.String value)
The name of the ledger that you want to create.
|
void |
setPermissionsMode(java.lang.String value)
The permissions mode to assign to the ledger that you want to create.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnLedger(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnLedger(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnLedger(Construct scope, java.lang.String id, CfnLedgerProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getPermissionsMode()
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.
public void setPermissionsMode(java.lang.String value)
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.
public java.lang.Object getDeletionProtection()
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 the parameter to false
.
public void setDeletionProtection(java.lang.Boolean value)
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 the parameter to false
.
public void setDeletionProtection(IResolvable value)
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 the parameter to false
.
public java.lang.String getKmsKey()
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.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:
1234abcd-12ab-34cd-56ef-1234567890ab
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
alias/ExampleAlias
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
public void setKmsKey(java.lang.String value)
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.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:
1234abcd-12ab-34cd-56ef-1234567890ab
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
alias/ExampleAlias
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
public java.lang.String getName()
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 .
public void setName(java.lang.String value)
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 .