Struct aws_sdk_qldb::operation::update_ledger::UpdateLedgerInput
source · #[non_exhaustive]pub struct UpdateLedgerInput {
pub name: Option<String>,
pub deletion_protection: Option<bool>,
pub kms_key: Option<String>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: Option<String>
The name of the ledger.
deletion_protection: 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
.
kms_key: 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.
Implementations§
source§impl UpdateLedgerInput
impl UpdateLedgerInput
sourcepub fn deletion_protection(&self) -> Option<bool>
pub fn 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) -> Option<&str>
pub fn kms_key(&self) -> Option<&str>
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.
source§impl UpdateLedgerInput
impl UpdateLedgerInput
sourcepub fn builder() -> UpdateLedgerInputBuilder
pub fn builder() -> UpdateLedgerInputBuilder
Creates a new builder-style object to manufacture UpdateLedgerInput
.
Trait Implementations§
source§impl Clone for UpdateLedgerInput
impl Clone for UpdateLedgerInput
source§fn clone(&self) -> UpdateLedgerInput
fn clone(&self) -> UpdateLedgerInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UpdateLedgerInput
impl Debug for UpdateLedgerInput
source§impl PartialEq for UpdateLedgerInput
impl PartialEq for UpdateLedgerInput
impl StructuralPartialEq for UpdateLedgerInput
Auto Trait Implementations§
impl Freeze for UpdateLedgerInput
impl RefUnwindSafe for UpdateLedgerInput
impl Send for UpdateLedgerInput
impl Sync for UpdateLedgerInput
impl Unpin for UpdateLedgerInput
impl UnwindSafe for UpdateLedgerInput
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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