Network.AWS.KMS.CreateAlias

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 .

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

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)

ToPath CreateAlias

Methods

toPath :: CreateAlias -> ByteString

ToHeaders CreateAlias

Methods

toHeaders :: CreateAlias -> [Header]

ToQuery CreateAlias

Methods

toQuery :: CreateAlias -> QueryString

type Rep CreateAlias

type Rep CreateAlias = D1 (MetaData "CreateAlias" "Network.AWS.KMS.CreateAlias" "amazonka-kms-1.4.5-2CcuwPQYK1JBjEgZ8528Xg" 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

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

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.4.5-2CcuwPQYK1JBjEgZ8528Xg" False) (C1 (MetaCons "CreateAliasResponse'" PrefixI False) U1)