Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.KMS.CreateAlias

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Creates a friendly name for a KMS key.

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

You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and GenerateDataKey. You can also change the KMS key that's associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don't affect the underlying KMS key.

You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an alias without a KMS key.

The alias must be unique in the account and Region, but you can have aliases with the same name in different Regions. For detailed information about aliases, see Using aliases in the Key Management Service Developer Guide.

This operation does not return a response. To get the alias that you created, use the ListAliases operation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

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

Required permissions

kms:CreateAlias on the alias (IAM policy).
kms:CreateAlias on the KMS key (key policy).

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

Related operations:

DeleteAlias
ListAliases
UpdateAlias

Synopsis

data CreateAlias = CreateAlias' {
- aliasName :: Text
- targetKeyId :: Text
}
newCreateAlias :: Text -> Text -> CreateAlias
createAlias_aliasName :: Lens' CreateAlias Text
createAlias_targetKeyId :: Lens' CreateAlias Text
data CreateAliasResponse = CreateAliasResponse' {
}
newCreateAliasResponse :: CreateAliasResponse

Creating a Request

data CreateAlias Source #

See: newCreateAlias smart constructor.

Constructors

CreateAlias'

Fields

aliasName :: Text
Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.
The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.
targetKeyId :: Text
Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.
A valid key ID is required. If you supply a null or empty string value, this operation returns an error.
For help finding the key ID and ARN, see Finding the Key ID and ARN in the /Key Management Service Developer Guide/ .
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.

Instances

Instances details

Eq CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods (==) :: CreateAlias -> CreateAlias -> Bool # (/=) :: CreateAlias -> CreateAlias -> Bool #
Read CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods readsPrec :: Int -> ReadS CreateAlias # readList :: ReadS [CreateAlias] # readPrec :: ReadPrec CreateAlias # readListPrec :: ReadPrec [CreateAlias] #
Show CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods showsPrec :: Int -> CreateAlias -> ShowS # show :: CreateAlias -> String # showList :: [CreateAlias] -> ShowS #
Generic CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Associated Types type Rep CreateAlias :: Type -> Type # Methods from :: CreateAlias -> Rep CreateAlias x # to :: Rep CreateAlias x -> CreateAlias #
NFData CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods rnf :: CreateAlias -> () #
Hashable CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods hashWithSalt :: Int -> CreateAlias -> Int # hash :: CreateAlias -> Int #
ToJSON CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods toJSON :: CreateAlias -> Value # toEncoding :: CreateAlias -> Encoding # toJSONList :: [CreateAlias] -> Value # toEncodingList :: [CreateAlias] -> Encoding #
AWSRequest CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Associated Types type AWSResponse CreateAlias # Methods request :: CreateAlias -> Request CreateAlias # response :: MonadResource m => Logger -> Service -> Proxy CreateAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAlias))) #
ToHeaders CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods toHeaders :: CreateAlias -> [Header] #
ToPath CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods toPath :: CreateAlias -> ByteString #
ToQuery CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods toQuery :: CreateAlias -> QueryString #
type Rep CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias type Rep CreateAlias = D1 ('MetaData "CreateAlias" "Amazonka.KMS.CreateAlias" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "CreateAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliasName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateAlias Source #
Instance details Defined in Amazonka.KMS.CreateAlias type AWSResponse CreateAlias = CreateAliasResponse

newCreateAlias Source #

Arguments

:: Text	`$sel:aliasName:CreateAlias'`
-> Text	`$sel:targetKeyId:CreateAlias'`
-> CreateAlias

Create a value of CreateAlias with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aliasName:CreateAlias', createAlias_aliasName - Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

$sel:targetKeyId:CreateAlias', createAlias_targetKeyId - Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the /Key Management Service Developer Guide/ .

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.

Request Lenses

createAlias_aliasName :: Lens' CreateAlias Text Source #

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

createAlias_targetKeyId :: Lens' CreateAlias Text Source #

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the /Key Management Service Developer Guide/ .

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.

Destructuring the Response

data CreateAliasResponse Source #

See: newCreateAliasResponse smart constructor.

Constructors

CreateAliasResponse'

Instances

Instances details

Eq CreateAliasResponse Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods (==) :: CreateAliasResponse -> CreateAliasResponse -> Bool # (/=) :: CreateAliasResponse -> CreateAliasResponse -> Bool #
Read CreateAliasResponse Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods readsPrec :: Int -> ReadS CreateAliasResponse # readList :: ReadS [CreateAliasResponse] # readPrec :: ReadPrec CreateAliasResponse # readListPrec :: ReadPrec [CreateAliasResponse] #
Show CreateAliasResponse Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods showsPrec :: Int -> CreateAliasResponse -> ShowS # show :: CreateAliasResponse -> String # showList :: [CreateAliasResponse] -> ShowS #
Generic CreateAliasResponse Source #
Instance details Defined in Amazonka.KMS.CreateAlias Associated Types type Rep CreateAliasResponse :: Type -> Type # Methods from :: CreateAliasResponse -> Rep CreateAliasResponse x # to :: Rep CreateAliasResponse x -> CreateAliasResponse #
NFData CreateAliasResponse Source #
Instance details Defined in Amazonka.KMS.CreateAlias Methods rnf :: CreateAliasResponse -> () #
type Rep CreateAliasResponse Source #
Instance details Defined in Amazonka.KMS.CreateAlias type Rep CreateAliasResponse = D1 ('MetaData "CreateAliasResponse" "Amazonka.KMS.CreateAlias" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "CreateAliasResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newCreateAliasResponse :: CreateAliasResponse Source #

Create a value of CreateAliasResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.