#[non_exhaustive]pub struct UpdateLedgerInputBuilder { /* private fields */ }
Expand description
A builder for UpdateLedgerInput
.
Implementations§
source§impl UpdateLedgerInputBuilder
impl UpdateLedgerInputBuilder
sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the ledger.
This field is required.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: Make no changes to the KMS key of the ledger.
-
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: Make no changes to the KMS key of the ledger.
-
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: Make no changes to the KMS key of the ledger.
-
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 build(self) -> Result<UpdateLedgerInput, BuildError>
pub fn build(self) -> Result<UpdateLedgerInput, BuildError>
Consumes the builder and constructs a UpdateLedgerInput
.
source§impl UpdateLedgerInputBuilder
impl UpdateLedgerInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<UpdateLedgerOutput, SdkError<UpdateLedgerError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<UpdateLedgerOutput, SdkError<UpdateLedgerError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for UpdateLedgerInputBuilder
impl Clone for UpdateLedgerInputBuilder
source§fn clone(&self) -> UpdateLedgerInputBuilder
fn clone(&self) -> UpdateLedgerInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UpdateLedgerInputBuilder
impl Debug for UpdateLedgerInputBuilder
source§impl Default for UpdateLedgerInputBuilder
impl Default for UpdateLedgerInputBuilder
source§fn default() -> UpdateLedgerInputBuilder
fn default() -> UpdateLedgerInputBuilder
source§impl PartialEq for UpdateLedgerInputBuilder
impl PartialEq for UpdateLedgerInputBuilder
source§fn eq(&self, other: &UpdateLedgerInputBuilder) -> bool
fn eq(&self, other: &UpdateLedgerInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for UpdateLedgerInputBuilder
Auto Trait Implementations§
impl Freeze for UpdateLedgerInputBuilder
impl RefUnwindSafe for UpdateLedgerInputBuilder
impl Send for UpdateLedgerInputBuilder
impl Sync for UpdateLedgerInputBuilder
impl Unpin for UpdateLedgerInputBuilder
impl UnwindSafe for UpdateLedgerInputBuilder
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