Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Lambda.CreateAlias

Contents

Description

Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

Synopsis

data CreateAlias = CreateAlias' {
- description :: Maybe Text
- routingConfig :: Maybe AliasRoutingConfiguration
- functionName :: Text
- name :: Text
- functionVersion :: Text
}
newCreateAlias :: Text -> Text -> Text -> CreateAlias
createAlias_description :: Lens' CreateAlias (Maybe Text)
createAlias_routingConfig :: Lens' CreateAlias (Maybe AliasRoutingConfiguration)
createAlias_functionName :: Lens' CreateAlias Text
createAlias_name :: Lens' CreateAlias Text
createAlias_functionVersion :: Lens' CreateAlias Text
data AliasConfiguration = AliasConfiguration' {
- aliasArn :: Maybe Text
- description :: Maybe Text
- functionVersion :: Maybe Text
- name :: Maybe Text
- revisionId :: Maybe Text
- routingConfig :: Maybe AliasRoutingConfiguration
}
newAliasConfiguration :: AliasConfiguration
aliasConfiguration_aliasArn :: Lens' AliasConfiguration (Maybe Text)
aliasConfiguration_description :: Lens' AliasConfiguration (Maybe Text)
aliasConfiguration_functionVersion :: Lens' AliasConfiguration (Maybe Text)
aliasConfiguration_name :: Lens' AliasConfiguration (Maybe Text)
aliasConfiguration_revisionId :: Lens' AliasConfiguration (Maybe Text)
aliasConfiguration_routingConfig :: Lens' AliasConfiguration (Maybe AliasRoutingConfiguration)

Creating a Request

data CreateAlias Source #

See: newCreateAlias smart constructor.

Constructors

CreateAlias'

Fields

description :: Maybe Text
A description of the alias.
routingConfig :: Maybe AliasRoutingConfiguration
The routing configuration of the alias.
functionName :: Text
The name of the Lambda function.
Name formats
- Function name - MyFunction.
- Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
- Partial ARN - 123456789012:function:MyFunction.
The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.
name :: Text
The name of the alias.
functionVersion :: Text
The function version that the alias invokes.

Instances

Instances details

ToJSON CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods toJSON :: CreateAlias -> Value # toEncoding :: CreateAlias -> Encoding # toJSONList :: [CreateAlias] -> Value # toEncodingList :: [CreateAlias] -> Encoding #
ToHeaders CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods toHeaders :: CreateAlias -> [Header] #
ToPath CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods toPath :: CreateAlias -> ByteString #
ToQuery CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods toQuery :: CreateAlias -> QueryString #
AWSRequest CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Associated Types type AWSResponse CreateAlias # Methods request :: (Service -> Service) -> CreateAlias -> Request CreateAlias # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAlias))) #
Generic CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Associated Types type Rep CreateAlias :: Type -> Type # Methods from :: CreateAlias -> Rep CreateAlias x # to :: Rep CreateAlias x -> CreateAlias #
Read CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods readsPrec :: Int -> ReadS CreateAlias # readList :: ReadS [CreateAlias] # readPrec :: ReadPrec CreateAlias # readListPrec :: ReadPrec [CreateAlias] #
Show CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods showsPrec :: Int -> CreateAlias -> ShowS # show :: CreateAlias -> String # showList :: [CreateAlias] -> ShowS #
NFData CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods rnf :: CreateAlias -> () #
Eq CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods (==) :: CreateAlias -> CreateAlias -> Bool # (/=) :: CreateAlias -> CreateAlias -> Bool #
Hashable CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias Methods hashWithSalt :: Int -> CreateAlias -> Int # hash :: CreateAlias -> Int #
type AWSResponse CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias type AWSResponse CreateAlias = AliasConfiguration
type Rep CreateAlias Source #
Instance details Defined in Amazonka.Lambda.CreateAlias type Rep CreateAlias = D1 ('MetaData "CreateAlias" "Amazonka.Lambda.CreateAlias" "amazonka-lambda-2.0-FcjxCCKaCGK94C2lDO9alC" 'False) (C1 ('MetaCons "CreateAlias'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "routingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AliasRoutingConfiguration))) :: (S1 ('MetaSel ('Just "functionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "functionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAlias Source #

Arguments

:: Text	`CreateAlias`
-> Text	`CreateAlias`
-> Text	`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:

CreateAlias, createAlias_description - A description of the alias.

CreateAlias, createAlias_routingConfig - The routing configuration of the alias.

CreateAlias, createAlias_functionName - The name of the Lambda function.

Name formats

Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

CreateAlias, createAlias_name - The name of the alias.

CreateAlias, createAlias_functionVersion - The function version that the alias invokes.

Request Lenses

createAlias_description :: Lens' CreateAlias (Maybe Text) Source #

A description of the alias.

createAlias_routingConfig :: Lens' CreateAlias (Maybe AliasRoutingConfiguration) Source #

The routing configuration of the alias.

createAlias_functionName :: Lens' CreateAlias Text Source #

The name of the Lambda function.

Name formats

Function name - MyFunction.
Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

createAlias_name :: Lens' CreateAlias Text Source #

The name of the alias.

createAlias_functionVersion :: Lens' CreateAlias Text Source #

The function version that the alias invokes.

Destructuring the Response

data AliasConfiguration Source #

Provides configuration information about a Lambda function alias.

See: newAliasConfiguration smart constructor.

Constructors

AliasConfiguration'

Fields

aliasArn :: Maybe Text
The Amazon Resource Name (ARN) of the alias.
description :: Maybe Text
A description of the alias.
functionVersion :: Maybe Text
The function version that the alias invokes.
name :: Maybe Text
The name of the alias.
revisionId :: Maybe Text
A unique identifier that changes when you update the alias.
routingConfig :: Maybe AliasRoutingConfiguration
The routing configuration of the alias.

Instances

Instances details

FromJSON AliasConfiguration Source #
Instance details Defined in Amazonka.Lambda.Types.AliasConfiguration Methods parseJSON :: Value -> Parser AliasConfiguration # parseJSONList :: Value -> Parser [AliasConfiguration] #
Generic AliasConfiguration Source #
Instance details Defined in Amazonka.Lambda.Types.AliasConfiguration Associated Types type Rep AliasConfiguration :: Type -> Type # Methods from :: AliasConfiguration -> Rep AliasConfiguration x # to :: Rep AliasConfiguration x -> AliasConfiguration #
Read AliasConfiguration Source #
Instance details Defined in Amazonka.Lambda.Types.AliasConfiguration Methods readsPrec :: Int -> ReadS AliasConfiguration # readList :: ReadS [AliasConfiguration] # readPrec :: ReadPrec AliasConfiguration # readListPrec :: ReadPrec [AliasConfiguration] #
Show AliasConfiguration Source #
Instance details Defined in Amazonka.Lambda.Types.AliasConfiguration Methods showsPrec :: Int -> AliasConfiguration -> ShowS # show :: AliasConfiguration -> String # showList :: [AliasConfiguration] -> ShowS #
NFData AliasConfiguration Source #
Instance details Defined in Amazonka.Lambda.Types.AliasConfiguration Methods rnf :: AliasConfiguration -> () #
Eq AliasConfiguration Source #
Instance details Defined in Amazonka.Lambda.Types.AliasConfiguration Methods (==) :: AliasConfiguration -> AliasConfiguration -> Bool # (/=) :: AliasConfiguration -> AliasConfiguration -> Bool #
Hashable AliasConfiguration Source #
Instance details Defined in Amazonka.Lambda.Types.AliasConfiguration Methods hashWithSalt :: Int -> AliasConfiguration -> Int # hash :: AliasConfiguration -> Int #
type Rep AliasConfiguration Source #
Instance details Defined in Amazonka.Lambda.Types.AliasConfiguration type Rep AliasConfiguration = D1 ('MetaData "AliasConfiguration" "Amazonka.Lambda.Types.AliasConfiguration" "amazonka-lambda-2.0-FcjxCCKaCGK94C2lDO9alC" 'False) (C1 ('MetaCons "AliasConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aliasArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "functionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "routingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AliasRoutingConfiguration))))))

newAliasConfiguration :: AliasConfiguration Source #

Create a value of AliasConfiguration 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:aliasArn:AliasConfiguration', aliasConfiguration_aliasArn - The Amazon Resource Name (ARN) of the alias.

$sel:description:AliasConfiguration', aliasConfiguration_description - A description of the alias.

$sel:functionVersion:AliasConfiguration', aliasConfiguration_functionVersion - The function version that the alias invokes.

$sel:name:AliasConfiguration', aliasConfiguration_name - The name of the alias.

$sel:revisionId:AliasConfiguration', aliasConfiguration_revisionId - A unique identifier that changes when you update the alias.

$sel:routingConfig:AliasConfiguration', aliasConfiguration_routingConfig - The routing configuration of the alias.

Response Lenses

aliasConfiguration_aliasArn :: Lens' AliasConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the alias.

aliasConfiguration_description :: Lens' AliasConfiguration (Maybe Text) Source #

A description of the alias.

aliasConfiguration_functionVersion :: Lens' AliasConfiguration (Maybe Text) Source #

The function version that the alias invokes.

aliasConfiguration_name :: Lens' AliasConfiguration (Maybe Text) Source #

The name of the alias.

aliasConfiguration_revisionId :: Lens' AliasConfiguration (Maybe Text) Source #

A unique identifier that changes when you update the alias.

aliasConfiguration_routingConfig :: Lens' AliasConfiguration (Maybe AliasRoutingConfiguration) Source #

The routing configuration of the alias.