Struct aws_sdk_kms::operation::delete_imported_key_material::builders::DeleteImportedKeyMaterialFluentBuilder
source · pub struct DeleteImportedKeyMaterialFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DeleteImportedKeyMaterial
.
Deletes key material that was previously imported. This operation makes the specified KMS key temporarily unusable. To restore the usability of the KMS key, reimport the same key material. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide.
When the specified KMS key is in the PendingDeletion
state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to PendingImport
.
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:DeleteImportedKeyMaterial (key policy)
Related operations:
-
GetParametersForImport
-
ImportKeyMaterial
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Implementations§
source§impl DeleteImportedKeyMaterialFluentBuilder
impl DeleteImportedKeyMaterialFluentBuilder
sourcepub fn as_input(&self) -> &DeleteImportedKeyMaterialInputBuilder
pub fn as_input(&self) -> &DeleteImportedKeyMaterialInputBuilder
Access the DeleteImportedKeyMaterial as a reference.
sourcepub async fn send(
self
) -> Result<DeleteImportedKeyMaterialOutput, SdkError<DeleteImportedKeyMaterialError, HttpResponse>>
pub async fn send( self ) -> Result<DeleteImportedKeyMaterialOutput, SdkError<DeleteImportedKeyMaterialError, 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<DeleteImportedKeyMaterialOutput, DeleteImportedKeyMaterialError, Self>
pub fn customize( self ) -> CustomizableOperation<DeleteImportedKeyMaterialOutput, DeleteImportedKeyMaterialError, 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 from which you are deleting imported key material. The Origin
of the KMS key must be EXTERNAL
.
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 from which you are deleting imported key material. The Origin
of the KMS key must be EXTERNAL
.
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 from which you are deleting imported key material. The Origin
of the KMS key must be EXTERNAL
.
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 DeleteImportedKeyMaterialFluentBuilder
impl Clone for DeleteImportedKeyMaterialFluentBuilder
source§fn clone(&self) -> DeleteImportedKeyMaterialFluentBuilder
fn clone(&self) -> DeleteImportedKeyMaterialFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more