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.UpdateAlias

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Associates an existing KMS alias with a different KMS key. Each alias is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the KMS key must be in the same Amazon Web Services account and Region.

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.

The current and new KMS key must be the same type (both symmetric or both asymmetric), and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

You cannot use UpdateAlias to change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

Because an alias is not a property of a KMS key, you can create, update, and delete 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 in the account, 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 a KMS key in a different Amazon Web Services account.

Required permissions

kms:UpdateAlias on the alias (IAM policy).
kms:UpdateAlias on the current KMS key (key policy).
kms:UpdateAlias on the new KMS key (key policy).

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

Related operations:

CreateAlias
DeleteAlias
ListAliases

Synopsis

data UpdateAlias = UpdateAlias' {
- aliasName :: Text
- targetKeyId :: Text
}
newUpdateAlias :: Text -> Text -> UpdateAlias
updateAlias_aliasName :: Lens' UpdateAlias Text
updateAlias_targetKeyId :: Lens' UpdateAlias Text
data UpdateAliasResponse = UpdateAliasResponse' {
}
newUpdateAliasResponse :: UpdateAliasResponse

Creating a Request

data UpdateAlias Source #

See: newUpdateAlias smart constructor.

Constructors

UpdateAlias'

Fields

aliasName :: Text
Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.
targetKeyId :: Text
Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.
The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric) and they must have the same key usage.
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.
To verify that the alias is mapped to the correct KMS key, use ListAliases.

Instances

Instances details

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

newUpdateAlias Source #

Arguments

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

Create a value of UpdateAlias 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:UpdateAlias', updateAlias_aliasName - Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

$sel:targetKeyId:UpdateAlias', updateAlias_targetKeyId - Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct KMS key, use ListAliases.

Request Lenses

updateAlias_aliasName :: Lens' UpdateAlias Text Source #

Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

updateAlias_targetKeyId :: Lens' UpdateAlias Text Source #

Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct KMS key, use ListAliases.

Destructuring the Response

data UpdateAliasResponse Source #

See: newUpdateAliasResponse smart constructor.

Constructors

UpdateAliasResponse'

Instances

Instances details

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

newUpdateAliasResponse :: UpdateAliasResponse Source #

Create a value of UpdateAliasResponse with all optional fields omitted.

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