Struct aws_sdk_kms::operation::enable_key::builders::EnableKeyFluentBuilder
source · pub struct EnableKeyFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to EnableKey
.
Sets the key state of a KMS key to enabled. This allows you to use the KMS key for cryptographic operations.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:EnableKey (key policy)
Related operations: DisableKey
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Implementations§
source§impl EnableKeyFluentBuilder
impl EnableKeyFluentBuilder
sourcepub fn as_input(&self) -> &EnableKeyInputBuilder
pub fn as_input(&self) -> &EnableKeyInputBuilder
Access the EnableKey as a reference.
sourcepub async fn send(
self
) -> Result<EnableKeyOutput, SdkError<EnableKeyError, HttpResponse>>
pub async fn send( self ) -> Result<EnableKeyOutput, SdkError<EnableKeyError, 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<EnableKeyOutput, EnableKeyError, Self>
pub fn customize( self ) -> CustomizableOperation<EnableKeyOutput, EnableKeyError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn key_id(self, input: impl Into<String>) -> Self
pub fn key_id(self, input: impl Into<String>) -> Self
Identifies the KMS key to enable.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
.
sourcepub fn set_key_id(self, input: Option<String>) -> Self
pub fn set_key_id(self, input: Option<String>) -> Self
Identifies the KMS key to enable.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
.
sourcepub fn get_key_id(&self) -> &Option<String>
pub fn get_key_id(&self) -> &Option<String>
Identifies the KMS key to enable.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
.
Trait Implementations§
source§impl Clone for EnableKeyFluentBuilder
impl Clone for EnableKeyFluentBuilder
source§fn clone(&self) -> EnableKeyFluentBuilder
fn clone(&self) -> EnableKeyFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more