/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace QLDB { namespace Model { /** */ class CreateLedgerRequest : public QLDBRequest { public: AWS_QLDB_API CreateLedgerRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateLedger"; } AWS_QLDB_API Aws::String SerializePayload() const override; /** *

The name of the ledger that you want to create. The name must be unique among * all of the ledgers in your Amazon Web Services account in the current * Region.

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

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the ledger that you want to create. The name must be unique among * all of the ledgers in your Amazon Web Services account in the current * Region.

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

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the ledger that you want to create. The name must be unique among * all of the ledgers in your Amazon Web Services account in the current * Region.

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

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the ledger that you want to create. The name must be unique among * all of the ledgers in your Amazon Web Services account in the current * Region.

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

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the ledger that you want to create. The name must be unique among * all of the ledgers in your Amazon Web Services account in the current * Region.

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

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the ledger that you want to create. The name must be unique among * all of the ledgers in your Amazon Web Services account in the current * Region.

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

*/ inline CreateLedgerRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the ledger that you want to create. The name must be unique among * all of the ledgers in your Amazon Web Services account in the current * Region.

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

*/ inline CreateLedgerRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the ledger that you want to create. The name must be unique among * all of the ledgers in your Amazon Web Services account in the current * Region.

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

*/ inline CreateLedgerRequest& WithName(const char* value) { SetName(value); return *this;} /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline void SetTags(const Aws::Map& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline void SetTags(Aws::Map&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

The key-value pairs to add as tags to the ledger that you want to create. Tag * keys are case sensitive. Tag values are case sensitive and can be null.

*/ inline CreateLedgerRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

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.

*/ inline const PermissionsMode& GetPermissionsMode() const{ return m_permissionsMode; } /** *

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.

*/ inline bool PermissionsModeHasBeenSet() const { return m_permissionsModeHasBeenSet; } /** *

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.

*/ inline void SetPermissionsMode(const PermissionsMode& value) { m_permissionsModeHasBeenSet = true; m_permissionsMode = value; } /** *

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.

*/ inline void SetPermissionsMode(PermissionsMode&& value) { m_permissionsModeHasBeenSet = true; m_permissionsMode = std::move(value); } /** *

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.

*/ inline CreateLedgerRequest& WithPermissionsMode(const PermissionsMode& value) { SetPermissionsMode(value); return *this;} /** *

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.

*/ inline CreateLedgerRequest& WithPermissionsMode(PermissionsMode&& value) { SetPermissionsMode(std::move(value)); return *this;} /** *

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.

*/ inline bool GetDeletionProtection() const{ return m_deletionProtection; } /** *

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.

*/ inline bool DeletionProtectionHasBeenSet() const { return m_deletionProtectionHasBeenSet; } /** *

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.

*/ inline void SetDeletionProtection(bool value) { m_deletionProtectionHasBeenSet = true; m_deletionProtection = value; } /** *

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.

*/ inline CreateLedgerRequest& WithDeletionProtection(bool value) { SetDeletionProtection(value); return *this;} /** *

The key in Key Management Service (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 KMS key that is owned and managed by * Amazon Web Services on your behalf.

  • Undefined: By * default, use an Amazon Web Services 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 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 Amazon Web Services 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 Key Management Service Developer * Guide.

*/ inline const Aws::String& GetKmsKey() const{ return m_kmsKey; } /** *

The key in Key Management Service (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 KMS key that is owned and managed by * Amazon Web Services on your behalf.

  • Undefined: By * default, use an Amazon Web Services 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 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 Amazon Web Services 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 Key Management Service Developer * Guide.

*/ inline bool KmsKeyHasBeenSet() const { return m_kmsKeyHasBeenSet; } /** *

The key in Key Management Service (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 KMS key that is owned and managed by * Amazon Web Services on your behalf.

  • Undefined: By * default, use an Amazon Web Services 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 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 Amazon Web Services 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 Key Management Service Developer * Guide.

*/ inline void SetKmsKey(const Aws::String& value) { m_kmsKeyHasBeenSet = true; m_kmsKey = value; } /** *

The key in Key Management Service (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 KMS key that is owned and managed by * Amazon Web Services on your behalf.

  • Undefined: By * default, use an Amazon Web Services 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 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 Amazon Web Services 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 Key Management Service Developer * Guide.

*/ inline void SetKmsKey(Aws::String&& value) { m_kmsKeyHasBeenSet = true; m_kmsKey = std::move(value); } /** *

The key in Key Management Service (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 KMS key that is owned and managed by * Amazon Web Services on your behalf.

  • Undefined: By * default, use an Amazon Web Services 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 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 Amazon Web Services 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 Key Management Service Developer * Guide.

*/ inline void SetKmsKey(const char* value) { m_kmsKeyHasBeenSet = true; m_kmsKey.assign(value); } /** *

The key in Key Management Service (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 KMS key that is owned and managed by * Amazon Web Services on your behalf.

  • Undefined: By * default, use an Amazon Web Services 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 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 Amazon Web Services 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 Key Management Service Developer * Guide.

*/ inline CreateLedgerRequest& WithKmsKey(const Aws::String& value) { SetKmsKey(value); return *this;} /** *

The key in Key Management Service (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 KMS key that is owned and managed by * Amazon Web Services on your behalf.

  • Undefined: By * default, use an Amazon Web Services 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 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 Amazon Web Services 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 Key Management Service Developer * Guide.

*/ inline CreateLedgerRequest& WithKmsKey(Aws::String&& value) { SetKmsKey(std::move(value)); return *this;} /** *

The key in Key Management Service (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 KMS key that is owned and managed by * Amazon Web Services on your behalf.

  • Undefined: By * default, use an Amazon Web Services 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 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 Amazon Web Services 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 Key Management Service Developer * Guide.

*/ inline CreateLedgerRequest& WithKmsKey(const char* value) { SetKmsKey(value); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::Map m_tags; bool m_tagsHasBeenSet = false; PermissionsMode m_permissionsMode; bool m_permissionsModeHasBeenSet = false; bool m_deletionProtection; bool m_deletionProtectionHasBeenSet = false; Aws::String m_kmsKey; bool m_kmsKeyHasBeenSet = false; }; } // namespace Model } // namespace QLDB } // namespace Aws