Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.QLDB.CreateLedger

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new ledger in your account in the current Region.

Synopsis

data CreateLedger = CreateLedger' {
- deletionProtection :: Maybe Bool
- kmsKey :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
- permissionsMode :: PermissionsMode
}
newCreateLedger :: Text -> PermissionsMode -> CreateLedger
createLedger_deletionProtection :: Lens' CreateLedger (Maybe Bool)
createLedger_kmsKey :: Lens' CreateLedger (Maybe Text)
createLedger_tags :: Lens' CreateLedger (Maybe (HashMap Text Text))
createLedger_name :: Lens' CreateLedger Text
createLedger_permissionsMode :: Lens' CreateLedger PermissionsMode
data CreateLedgerResponse = CreateLedgerResponse' {
- state :: Maybe LedgerState
- deletionProtection :: Maybe Bool
- kmsKeyArn :: Maybe Text
- arn :: Maybe Text
- name :: Maybe Text
- creationDateTime :: Maybe POSIX
- permissionsMode :: Maybe PermissionsMode
- httpStatus :: Int
}
newCreateLedgerResponse :: Int -> CreateLedgerResponse
createLedgerResponse_state :: Lens' CreateLedgerResponse (Maybe LedgerState)
createLedgerResponse_deletionProtection :: Lens' CreateLedgerResponse (Maybe Bool)
createLedgerResponse_kmsKeyArn :: Lens' CreateLedgerResponse (Maybe Text)
createLedgerResponse_arn :: Lens' CreateLedgerResponse (Maybe Text)
createLedgerResponse_name :: Lens' CreateLedgerResponse (Maybe Text)
createLedgerResponse_creationDateTime :: Lens' CreateLedgerResponse (Maybe UTCTime)
createLedgerResponse_permissionsMode :: Lens' CreateLedgerResponse (Maybe PermissionsMode)
createLedgerResponse_httpStatus :: Lens' CreateLedgerResponse Int

Creating a Request

data CreateLedger Source #

See: newCreateLedger smart constructor.

Constructors

CreateLedger'

Fields

deletionProtection :: Maybe Bool
The flag that prevents a ledger from being deleted by any user. If not provided on 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 flag to false.
kmsKey :: Maybe Text
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 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 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.
tags :: Maybe (HashMap Text Text)
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.
name :: Text
The name of the ledger that you want to create. The name must be unique among all of the ledgers in your account in the current Region.
Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
permissionsMode :: 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.

Instances

Instances details

Eq CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods (==) :: CreateLedger -> CreateLedger -> Bool # (/=) :: CreateLedger -> CreateLedger -> Bool #
Read CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods readsPrec :: Int -> ReadS CreateLedger # readList :: ReadS [CreateLedger] # readPrec :: ReadPrec CreateLedger # readListPrec :: ReadPrec [CreateLedger] #
Show CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods showsPrec :: Int -> CreateLedger -> ShowS # show :: CreateLedger -> String # showList :: [CreateLedger] -> ShowS #
Generic CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Associated Types type Rep CreateLedger :: Type -> Type # Methods from :: CreateLedger -> Rep CreateLedger x # to :: Rep CreateLedger x -> CreateLedger #
NFData CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods rnf :: CreateLedger -> () #
Hashable CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods hashWithSalt :: Int -> CreateLedger -> Int # hash :: CreateLedger -> Int #
ToJSON CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods toJSON :: CreateLedger -> Value # toEncoding :: CreateLedger -> Encoding # toJSONList :: [CreateLedger] -> Value # toEncodingList :: [CreateLedger] -> Encoding #
AWSRequest CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Associated Types type AWSResponse CreateLedger # Methods request :: CreateLedger -> Request CreateLedger # response :: MonadResource m => Logger -> Service -> Proxy CreateLedger -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLedger))) #
ToHeaders CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods toHeaders :: CreateLedger -> [Header] #
ToPath CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods toPath :: CreateLedger -> ByteString #
ToQuery CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods toQuery :: CreateLedger -> QueryString #
type Rep CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger type Rep CreateLedger = D1 ('MetaData "CreateLedger" "Amazonka.QLDB.CreateLedger" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "CreateLedger'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "permissionsMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PermissionsMode)))))
type AWSResponse CreateLedger Source #
Instance details Defined in Amazonka.QLDB.CreateLedger type AWSResponse CreateLedger = CreateLedgerResponse

newCreateLedger Source #

Arguments

:: Text	`$sel:name:CreateLedger'`
-> PermissionsMode	`$sel:permissionsMode:CreateLedger'`
-> CreateLedger

Create a value of CreateLedger with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deletionProtection:CreateLedger', createLedger_deletionProtection - The flag that prevents a ledger from being deleted by any user. If not provided on 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 flag to false.

$sel:kmsKey:CreateLedger', createLedger_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 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 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.

$sel:tags:CreateLedger', createLedger_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.

$sel:name:CreateLedger', createLedger_name - The name of the ledger that you want to create. The name must be unique among all of the ledgers in your account in the current Region.

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

$sel:permissionsMode:CreateLedger', createLedger_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.

Request Lenses

createLedger_deletionProtection :: Lens' CreateLedger (Maybe Bool) Source #

The flag that prevents a ledger from being deleted by any user. If not provided on 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 flag to false.

createLedger_kmsKey :: Lens' CreateLedger (Maybe Text) Source #

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 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 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.

createLedger_tags :: Lens' CreateLedger (Maybe (HashMap Text Text)) Source #

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.

createLedger_name :: Lens' CreateLedger Text Source #

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

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

createLedger_permissionsMode :: Lens' CreateLedger PermissionsMode Source #

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.

Destructuring the Response

data CreateLedgerResponse Source #

See: newCreateLedgerResponse smart constructor.

Constructors

CreateLedgerResponse'

Fields

state :: Maybe LedgerState
The current status of the ledger.
deletionProtection :: Maybe Bool
The flag that prevents a ledger from being deleted by any user. If not provided on 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 flag to false.
kmsKeyArn :: Maybe Text
The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.
arn :: Maybe Text
The Amazon Resource Name (ARN) for the ledger.
name :: Maybe Text
The name of the ledger.
creationDateTime :: Maybe POSIX
The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
permissionsMode :: Maybe PermissionsMode
The permissions mode of the ledger that you created.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods (==) :: CreateLedgerResponse -> CreateLedgerResponse -> Bool # (/=) :: CreateLedgerResponse -> CreateLedgerResponse -> Bool #
Read CreateLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods readsPrec :: Int -> ReadS CreateLedgerResponse # readList :: ReadS [CreateLedgerResponse] # readPrec :: ReadPrec CreateLedgerResponse # readListPrec :: ReadPrec [CreateLedgerResponse] #
Show CreateLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods showsPrec :: Int -> CreateLedgerResponse -> ShowS # show :: CreateLedgerResponse -> String # showList :: [CreateLedgerResponse] -> ShowS #
Generic CreateLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Associated Types type Rep CreateLedgerResponse :: Type -> Type # Methods from :: CreateLedgerResponse -> Rep CreateLedgerResponse x # to :: Rep CreateLedgerResponse x -> CreateLedgerResponse #
NFData CreateLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.CreateLedger Methods rnf :: CreateLedgerResponse -> () #
type Rep CreateLedgerResponse Source #
Instance details Defined in Amazonka.QLDB.CreateLedger type Rep CreateLedgerResponse = D1 ('MetaData "CreateLedgerResponse" "Amazonka.QLDB.CreateLedger" "libZSservicesZSamazonka-qldbZSamazonka-qldb" 'False) (C1 ('MetaCons "CreateLedgerResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LedgerState)) :: S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "permissionsMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PermissionsMode)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateLedgerResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateLedgerResponse'`
-> CreateLedgerResponse

Create a value of CreateLedgerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:state:CreateLedgerResponse', createLedgerResponse_state - The current status of the ledger.

$sel:deletionProtection:CreateLedger', createLedgerResponse_deletionProtection - The flag that prevents a ledger from being deleted by any user. If not provided on 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 flag to false.

$sel:kmsKeyArn:CreateLedgerResponse', createLedgerResponse_kmsKeyArn - The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

$sel:arn:CreateLedgerResponse', createLedgerResponse_arn - The Amazon Resource Name (ARN) for the ledger.

$sel:name:CreateLedger', createLedgerResponse_name - The name of the ledger.

$sel:creationDateTime:CreateLedgerResponse', createLedgerResponse_creationDateTime - The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

$sel:permissionsMode:CreateLedger', createLedgerResponse_permissionsMode - The permissions mode of the ledger that you created.

$sel:httpStatus:CreateLedgerResponse', createLedgerResponse_httpStatus - The response's http status code.

Response Lenses

createLedgerResponse_state :: Lens' CreateLedgerResponse (Maybe LedgerState) Source #

The current status of the ledger.

createLedgerResponse_deletionProtection :: Lens' CreateLedgerResponse (Maybe Bool) Source #

The flag that prevents a ledger from being deleted by any user. If not provided on 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 flag to false.

createLedgerResponse_kmsKeyArn :: Lens' CreateLedgerResponse (Maybe Text) Source #

The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

createLedgerResponse_arn :: Lens' CreateLedgerResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the ledger.

createLedgerResponse_name :: Lens' CreateLedgerResponse (Maybe Text) Source #

The name of the ledger.

createLedgerResponse_creationDateTime :: Lens' CreateLedgerResponse (Maybe UTCTime) Source #

The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

createLedgerResponse_permissionsMode :: Lens' CreateLedgerResponse (Maybe PermissionsMode) Source #

The permissions mode of the ledger that you created.

createLedgerResponse_httpStatus :: Lens' CreateLedgerResponse Int Source #

The response's http status code.