| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.KMS.UpdateAlias
Description
Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
See: AWS API Reference for UpdateAlias.
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> UpdateAlias |
Creates a value of UpdateAlias with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data UpdateAlias Source
See: updateAlias smart constructor.
Instances
Request Lenses
uaAliasName :: Lens' UpdateAlias Text Source
String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
uaTargetKeyId :: Lens' UpdateAlias Text Source
Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.
- Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
- Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
You can call ListAliases to verify that the alias is mapped to the
correct TargetKeyId.
Destructuring the Response
updateAliasResponse :: UpdateAliasResponse Source
Creates a value of UpdateAliasResponse with the minimum fields required to make a request.
data UpdateAliasResponse Source
See: updateAliasResponse smart constructor.