Network.AWS.KMS.CreateAlias

Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey .

Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

An alias must start with the word alias followed by a forward slash (alias/ ). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with aws ; that alias name prefix is reserved by Amazon Web Services (AWS).

The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.

To map an existing alias to a different CMK, call UpdateAlias .

Creating a Request

createAlias

Arguments

:: Text

caAliasName

-> Text

caTargetKeyId

-> 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:

• caAliasName - String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias). Aliases that begin with "aliasAWS" are reserved.
• caTargetKeyId - Identifies the CMK for which you are creating the alias. This value cannot be an alias. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. 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 CMK, use ListKeys or DescribeKey .

data CreateAlias

See: createAlias smart constructor.

Instances

Eq CreateAlias

Methods

(==) :: CreateAlias -> CreateAlias -> Bool

(/=) :: CreateAlias -> CreateAlias -> Bool

Data CreateAlias

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateAlias -> c CreateAlias

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateAlias

toConstr :: CreateAlias -> Constr

dataTypeOf :: CreateAlias -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateAlias)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateAlias)

gmapT :: (forall b. Data b => b -> b) -> CreateAlias -> CreateAlias

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateAlias -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateAlias -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateAlias -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateAlias -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateAlias -> m CreateAlias

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAlias -> m CreateAlias

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAlias -> m CreateAlias

Read CreateAlias

Methods

readsPrec :: Int -> ReadS CreateAlias

readList :: ReadS [CreateAlias]

readPrec :: ReadPrec CreateAlias

readListPrec :: ReadPrec [CreateAlias]

Show CreateAlias

Methods

showsPrec :: Int -> CreateAlias -> ShowS

show :: CreateAlias -> String

showList :: [CreateAlias] -> ShowS

Generic CreateAlias

Associated Types

type Rep CreateAlias :: * -> *

Methods

from :: CreateAlias -> Rep CreateAlias x

to :: Rep CreateAlias x -> CreateAlias

Hashable CreateAlias

Methods

hashWithSalt :: Int -> CreateAlias -> Int

hash :: CreateAlias -> Int

ToJSON CreateAlias

Methods

toJSON :: CreateAlias -> Value

toEncoding :: CreateAlias -> Encoding

toJSONList :: [CreateAlias] -> Value

toEncodingList :: [CreateAlias] -> Encoding

NFData CreateAlias

Methods

rnf :: CreateAlias -> ()

AWSRequest CreateAlias

Associated Types

type Rs CreateAlias :: *

Methods

request :: CreateAlias -> Request CreateAlias

response :: MonadResource m => Logger -> Service -> Proxy * CreateAlias -> ClientResponse -> m (Response CreateAlias)

ToQuery CreateAlias

Methods

toQuery :: CreateAlias -> QueryString

ToPath CreateAlias

Methods

toPath :: CreateAlias -> ByteString

ToHeaders CreateAlias

Methods

toHeaders :: CreateAlias -> [Header]

type Rep CreateAlias

type Rep CreateAlias = D1 (MetaData "CreateAlias" "Network.AWS.KMS.CreateAlias" "amazonka-kms-1.5.0-1ul8bs34gET2EfYsh0ppOn" False) (C1 (MetaCons "CreateAlias'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_caAliasName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_caTargetKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs CreateAlias

type Rs CreateAlias = CreateAliasResponse

Request Lenses

caAliasName :: Lens' CreateAlias Text

String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias). Aliases that begin with "aliasAWS" are reserved.

caTargetKeyId :: Lens' CreateAlias Text

Identifies the CMK for which you are creating the alias. This value cannot be an alias. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. 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 CMK, use ListKeys or DescribeKey .

Destructuring the Response

createAliasResponse :: CreateAliasResponse

Creates a value of CreateAliasResponse with the minimum fields required to make a request.

data CreateAliasResponse

See: createAliasResponse smart constructor.

Instances

Eq CreateAliasResponse

Methods

(==) :: CreateAliasResponse -> CreateAliasResponse -> Bool

(/=) :: CreateAliasResponse -> CreateAliasResponse -> Bool

Data CreateAliasResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateAliasResponse -> c CreateAliasResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateAliasResponse

toConstr :: CreateAliasResponse -> Constr

dataTypeOf :: CreateAliasResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateAliasResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateAliasResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateAliasResponse -> CreateAliasResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateAliasResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateAliasResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateAliasResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateAliasResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateAliasResponse -> m CreateAliasResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAliasResponse -> m CreateAliasResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAliasResponse -> m CreateAliasResponse

Read CreateAliasResponse

Methods

readsPrec :: Int -> ReadS CreateAliasResponse

readList :: ReadS [CreateAliasResponse]

readPrec :: ReadPrec CreateAliasResponse

readListPrec :: ReadPrec [CreateAliasResponse]

Show CreateAliasResponse

Methods

showsPrec :: Int -> CreateAliasResponse -> ShowS

show :: CreateAliasResponse -> String

showList :: [CreateAliasResponse] -> ShowS

Generic CreateAliasResponse

Associated Types

type Rep CreateAliasResponse :: * -> *

Methods

from :: CreateAliasResponse -> Rep CreateAliasResponse x

to :: Rep CreateAliasResponse x -> CreateAliasResponse

NFData CreateAliasResponse

Methods

rnf :: CreateAliasResponse -> ()

type Rep CreateAliasResponse

type Rep CreateAliasResponse = D1 (MetaData "CreateAliasResponse" "Network.AWS.KMS.CreateAlias" "amazonka-kms-1.5.0-1ul8bs34gET2EfYsh0ppOn" False) (C1 (MetaCons "CreateAliasResponse'" PrefixI False) U1)