Struct aws_sdk_paymentcryptography::operation::create_alias::builders::CreateAliasFluentBuilder

pub struct CreateAliasFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateAlias.

Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.

You can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.

To change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

• DeleteAlias

• GetAlias

• ListAliases

• UpdateAlias

Implementations

impl CreateAliasFluentBuilder

pub fn as_input(&self) -> &CreateAliasInputBuilder

Access the CreateAlias as a reference.

pub async fn send( self ) -> Result<CreateAliasOutput, SdkError<CreateAliasError, 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.

pub async fn customize( self ) -> Result<CustomizableOperation<CreateAliasOutput, CreateAliasError, Self>, SdkError<CreateAliasError>>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

A friendly name that you can use to refer a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

A friendly name that you can use to refer a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

pub fn get_alias_name(&self) -> &Option<String>

A friendly name that you can use to refer a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

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

The KeyARN of the key to associate with the alias.

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

The KeyARN of the key to associate with the alias.

pub fn get_key_arn(&self) -> &Option<String>

The KeyARN of the key to associate with the alias.

Trait Implementations

impl Clone for CreateAliasFluentBuilder

fn clone(&self) -> CreateAliasFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAliasFluentBuilder

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

Formats the value using the given formatter.