| 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.CreateAlias
Description
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a 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.
To map an alias to a different key, call UpdateAlias.
See: AWS API Reference for CreateAlias.
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> CreateAlias |
Creates a value of CreateAlias with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateAlias Source
See: createAlias smart constructor.
Instances
Request Lenses
caAliasName :: Lens' CreateAlias Text Source
String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
caTargetKeyId :: Lens' CreateAlias Text Source
An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to 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
Destructuring the Response
createAliasResponse :: CreateAliasResponse Source
Creates a value of CreateAliasResponse with the minimum fields required to make a request.
data CreateAliasResponse Source
See: createAliasResponse smart constructor.