@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateLedgerRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description | 
|---|
CreateLedgerRequest()  | 
| Modifier and Type | Method and Description | 
|---|---|
CreateLedgerRequest | 
addTagsEntry(String key,
            String value)
Add a single Tags entry 
 | 
CreateLedgerRequest | 
clearTagsEntries()
Removes all the entries added into Tags. 
 | 
CreateLedgerRequest | 
clone()
Creates a shallow clone of this object for all fields except the handler context. 
 | 
boolean | 
equals(Object obj)  | 
Boolean | 
getDeletionProtection()
 Specifies whether the ledger is protected from being deleted by any user. 
 | 
String | 
getKmsKey()
 The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. 
 | 
String | 
getName()
 The name of the ledger that you want to create. 
 | 
String | 
getPermissionsMode()
 The permissions mode to assign to the ledger that you want to create. 
 | 
Map<String,String> | 
getTags()
 The key-value pairs to add as tags to the ledger that you want to create. 
 | 
int | 
hashCode()  | 
Boolean | 
isDeletionProtection()
 Specifies whether the ledger is protected from being deleted by any user. 
 | 
void | 
setDeletionProtection(Boolean deletionProtection)
 Specifies whether the ledger is protected from being deleted by any user. 
 | 
void | 
setKmsKey(String kmsKey)
 The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. 
 | 
void | 
setName(String name)
 The name of the ledger that you want to create. 
 | 
void | 
setPermissionsMode(String permissionsMode)
 The permissions mode to assign to the ledger that you want to create. 
 | 
void | 
setTags(Map<String,String> tags)
 The key-value pairs to add as tags to the ledger that you want to create. 
 | 
String | 
toString()
Returns a string representation of this object. 
 | 
CreateLedgerRequest | 
withDeletionProtection(Boolean deletionProtection)
 Specifies whether the ledger is protected from being deleted by any user. 
 | 
CreateLedgerRequest | 
withKmsKey(String kmsKey)
 The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. 
 | 
CreateLedgerRequest | 
withName(String name)
 The name of the ledger that you want to create. 
 | 
CreateLedgerRequest | 
withPermissionsMode(PermissionsMode permissionsMode)
 The permissions mode to assign to the ledger that you want to create. 
 | 
CreateLedgerRequest | 
withPermissionsMode(String permissionsMode)
 The permissions mode to assign to the ledger that you want to create. 
 | 
CreateLedgerRequest | 
withTags(Map<String,String> tags)
 The key-value pairs to add as tags to the ledger that you want to create. 
 | 
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setName(String 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.
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.
public String getName()
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.
Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
public CreateLedgerRequest withName(String 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.
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.
public Map<String,String> getTags()
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.
public void setTags(Map<String,String> 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.
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.public CreateLedgerRequest withTags(Map<String,String> 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.
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.public CreateLedgerRequest addTagsEntry(String key, String value)
public CreateLedgerRequest clearTagsEntries()
public void setPermissionsMode(String 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.
 
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.
        
PermissionsModepublic String getPermissionsMode()
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.
 
         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.
         
PermissionsModepublic CreateLedgerRequest withPermissionsMode(String 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.
 
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.
        
PermissionsModepublic CreateLedgerRequest withPermissionsMode(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.
 
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.
        
PermissionsModepublic void setDeletionProtection(Boolean 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.
 
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.
public Boolean getDeletionProtection()
 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.
 
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.
public CreateLedgerRequest withDeletionProtection(Boolean 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.
 
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.
public Boolean isDeletionProtection()
 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.
 
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.
public void setKmsKey(String 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.
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.
public String getKmsKey()
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.
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.
public CreateLedgerRequest withKmsKey(String 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.
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.
public String toString()
toString in class ObjectObject.toString()public CreateLedgerRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()