Interface ICfnLedgerProps
Properties for defining a CfnLedger
.
Namespace: Amazon.CDK.AWS.QLDB
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnLedgerProps
Syntax (vb)
Public Interface ICfnLedgerProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-ledger.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QLDB;
var cfnLedgerProps = new CfnLedgerProps {
PermissionsMode = "permissionsMode",
// the properties below are optional
DeletionProtection = false,
KmsKey = "kmsKey",
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
DeletionProtection | Specifies whether the ledger is protected from being deleted by any user. |
KmsKey | The key in AWS Key Management Service ( AWS KMS ) to use for encryption of data at rest in the ledger. |
Name | The name of the ledger that you want to create. |
PermissionsMode | The permissions mode to assign to the ledger that you want to create. |
Tags | An array of key-value pairs to apply to this resource. |
Properties
DeletionProtection
Specifies whether the ledger is protected from being deleted by any user.
virtual object DeletionProtection { get; }
Property Value
System.Object
Remarks
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
.
KmsKey
The key in AWS Key Management Service ( AWS KMS ) to use for encryption of data at rest in the ledger.
virtual string KmsKey { get; }
Property Value
System.String
Remarks
For more information, see Encryption at rest in the Amazon QLDB Developer Guide .
Use one of the following options to specify this parameter:
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:
For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .
Name
The name of the ledger that you want to create.
virtual string Name { get; }
Property Value
System.String
Remarks
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 .
PermissionsMode
The permissions mode to assign to the ledger that you want to create.
string PermissionsMode { get; }
Property Value
System.String
Remarks
This parameter can have one of the following values:
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.
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 <code>STANDARD</code> permissions mode to maximize the security of your ledger data.