Struct aws_sdk_kms::client::fluent_builders::DeleteAlias

pub struct DeleteAlias { /* private fields */ }

Fluent builder constructing a request to DeleteAlias.

Deletes the specified alias.

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC in KMS in the Key Management Service Developer Guide.

Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.

Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

Required permissions

• kms:DeleteAlias on the alias (IAM policy).

• kms:DeleteAlias on the KMS key (key policy).

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

Related operations:

• CreateAlias

• ListAliases

• UpdateAlias

Implementations

impl DeleteAlias

pub async fn send(self) -> Result<DeleteAliasOutput, SdkError<DeleteAliasError>>

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.

pub fn alias_name(self, input: impl Into<String>) -> Self

The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

pub fn set_alias_name(self, input: Option<String>) -> Self

The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

Trait Implementations

impl Clone for DeleteAlias

fn clone(&self) -> DeleteAlias

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeleteAlias

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.