pub struct CreateLedgerFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateLedger
.
Creates a new ledger in your Amazon Web Services account in the current Region.
Implementations§
source§impl CreateLedgerFluentBuilder
impl CreateLedgerFluentBuilder
sourcepub fn as_input(&self) -> &CreateLedgerInputBuilder
pub fn as_input(&self) -> &CreateLedgerInputBuilder
Access the CreateLedger as a reference.
sourcepub async fn send(
self
) -> Result<CreateLedgerOutput, SdkError<CreateLedgerError, HttpResponse>>
pub async fn send( self ) -> Result<CreateLedgerOutput, SdkError<CreateLedgerError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<CreateLedgerOutput, CreateLedgerError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateLedgerOutput, CreateLedgerError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
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.
Adds a key-value pair to Tags
.
To override the contents of this collection use set_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.
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.
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.
sourcepub fn permissions_mode(self, input: PermissionsMode) -> Self
pub fn permissions_mode(self, input: PermissionsMode) -> Self
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.
sourcepub fn set_permissions_mode(self, input: Option<PermissionsMode>) -> Self
pub fn set_permissions_mode(self, input: Option<PermissionsMode>) -> Self
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.
sourcepub fn get_permissions_mode(&self) -> &Option<PermissionsMode>
pub fn get_permissions_mode(&self) -> &Option<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.
sourcepub fn deletion_protection(self, input: bool) -> Self
pub fn deletion_protection(self, input: bool) -> Self
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
.
sourcepub fn set_deletion_protection(self, input: Option<bool>) -> Self
pub fn set_deletion_protection(self, input: Option<bool>) -> Self
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
.
sourcepub fn get_deletion_protection(&self) -> &Option<bool>
pub fn get_deletion_protection(&self) -> &Option<bool>
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
.
sourcepub fn kms_key(self, input: impl Into<String>) -> Self
pub fn kms_key(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_kms_key(self, input: Option<String>) -> Self
pub fn set_kms_key(self, input: Option<String>) -> Self
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.
sourcepub fn get_kms_key(&self) -> &Option<String>
pub fn get_kms_key(&self) -> &Option<String>
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.
Trait Implementations§
source§impl Clone for CreateLedgerFluentBuilder
impl Clone for CreateLedgerFluentBuilder
source§fn clone(&self) -> CreateLedgerFluentBuilder
fn clone(&self) -> CreateLedgerFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateLedgerFluentBuilder
impl !RefUnwindSafe for CreateLedgerFluentBuilder
impl Send for CreateLedgerFluentBuilder
impl Sync for CreateLedgerFluentBuilder
impl Unpin for CreateLedgerFluentBuilder
impl !UnwindSafe for CreateLedgerFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more