Network.AWS.APIGateway.CreateAuthorizer

Adds a new Authorizer resource to an existing RestApi resource.

Creating a Request

createAuthorizer

Arguments

:: Text

caRestAPIId

-> Text

caName

-> AuthorizerType

caType

-> Text

caAuthorizerURI

-> Text

caIdentitySource

-> CreateAuthorizer

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

Use one of the following lenses to modify other fields as desired:

• caIdentityValidationExpression
• caAuthorizerResultTtlInSeconds
• caAuthType
• caAuthorizerCredentials
• caRestAPIId
• caName
• caType
• caAuthorizerURI
• caIdentitySource

data CreateAuthorizer

Request to add a new Authorizer to an existing RestApi resource.

See: createAuthorizer smart constructor.

Instances

Eq CreateAuthorizer

Methods

(==) :: CreateAuthorizer -> CreateAuthorizer -> Bool

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

Data CreateAuthorizer

Methods

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

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

toConstr :: CreateAuthorizer -> Constr

dataTypeOf :: CreateAuthorizer -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateAuthorizer

Methods

readsPrec :: Int -> ReadS CreateAuthorizer

readList :: ReadS [CreateAuthorizer]

readPrec :: ReadPrec CreateAuthorizer

readListPrec :: ReadPrec [CreateAuthorizer]

Show CreateAuthorizer

Methods

showsPrec :: Int -> CreateAuthorizer -> ShowS

show :: CreateAuthorizer -> String

showList :: [CreateAuthorizer] -> ShowS

Generic CreateAuthorizer

Associated Types

type Rep CreateAuthorizer :: * -> *

Methods

from :: CreateAuthorizer -> Rep CreateAuthorizer x

to :: Rep CreateAuthorizer x -> CreateAuthorizer

ToJSON CreateAuthorizer

Methods

toJSON :: CreateAuthorizer -> Value

toEncoding :: CreateAuthorizer -> Encoding

Hashable CreateAuthorizer

Methods

hashWithSalt :: Int -> CreateAuthorizer -> Int

hash :: CreateAuthorizer -> Int

NFData CreateAuthorizer

Methods

rnf :: CreateAuthorizer -> ()

AWSRequest CreateAuthorizer

Associated Types

type Rs CreateAuthorizer :: *

Methods

request :: CreateAuthorizer -> Request CreateAuthorizer

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

ToPath CreateAuthorizer

Methods

toPath :: CreateAuthorizer -> ByteString

ToHeaders CreateAuthorizer

Methods

toHeaders :: CreateAuthorizer -> [Header]

ToQuery CreateAuthorizer

Methods

toQuery :: CreateAuthorizer -> QueryString

type Rep CreateAuthorizer

type Rep CreateAuthorizer = D1 (MetaData "CreateAuthorizer" "Network.AWS.APIGateway.CreateAuthorizer" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "CreateAuthorizer'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_caIdentityValidationExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_caAuthorizerResultTtlInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_caAuthType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_caAuthorizerCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_caRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_caName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_caType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AuthorizerType)) ((:*:) (S1 (MetaSel (Just Symbol "_caAuthorizerURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_caIdentitySource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateAuthorizer

type Rs CreateAuthorizer = Authorizer

Request Lenses

caIdentityValidationExpression :: Lens' CreateAuthorizer (Maybe Text)

A validation expression for the incoming identity.

caAuthorizerResultTtlInSeconds :: Lens' CreateAuthorizer (Maybe Int)

The TTL of cached authorizer results.

caAuthType :: Lens' CreateAuthorizer (Maybe Text)

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

caAuthorizerCredentials :: Lens' CreateAuthorizer (Maybe Text)

Specifies the credentials required for the authorizer, if any.

caRestAPIId :: Lens' CreateAuthorizer Text

The RestApi identifier under which the Authorizer will be created.

caName :: Lens' CreateAuthorizer Text

Required

The name of the authorizer.

caType :: Lens' CreateAuthorizer AuthorizerType

Required

The type of the authorizer.

caAuthorizerURI :: Lens' CreateAuthorizer Text

Required

Specifies the authorizer's Uniform Resource Identifier (URI).

caIdentitySource :: Lens' CreateAuthorizer Text

Required

The source of the identity in an incoming request.

Destructuring the Response

authorizer :: Authorizer

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

Use one of the following lenses to modify other fields as desired:

• aAuthorizerURI
• aIdentityValidationExpression
• aName
• aId
• aAuthorizerResultTtlInSeconds
• aAuthType
• aType
• aIdentitySource
• aAuthorizerCredentials

data Authorizer

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

See: authorizer smart constructor.

Instances

Eq Authorizer

Methods

(==) :: Authorizer -> Authorizer -> Bool

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

Data Authorizer

Methods

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

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

toConstr :: Authorizer -> Constr

dataTypeOf :: Authorizer -> DataType

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

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

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

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

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

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

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

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

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

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

Read Authorizer

Methods

readsPrec :: Int -> ReadS Authorizer

readList :: ReadS [Authorizer]

readPrec :: ReadPrec Authorizer

readListPrec :: ReadPrec [Authorizer]

Show Authorizer

Methods

showsPrec :: Int -> Authorizer -> ShowS

show :: Authorizer -> String

showList :: [Authorizer] -> ShowS

Generic Authorizer

Associated Types

type Rep Authorizer :: * -> *

Methods

from :: Authorizer -> Rep Authorizer x

to :: Rep Authorizer x -> Authorizer

FromJSON Authorizer

Methods

parseJSON :: Value -> Parser Authorizer

Hashable Authorizer

Methods

hashWithSalt :: Int -> Authorizer -> Int

hash :: Authorizer -> Int

NFData Authorizer

Methods

rnf :: Authorizer -> ()

type Rep Authorizer

type Rep Authorizer = D1 (MetaData "Authorizer" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Authorizer'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aAuthorizerURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aIdentityValidationExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aAuthorizerResultTtlInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_aAuthType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AuthorizerType))) ((:*:) (S1 (MetaSel (Just Symbol "_aIdentitySource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aAuthorizerCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

Response Lenses

aAuthorizerURI :: Lens' Authorizer (Maybe Text)

Required

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI. The URI should be of the form 'arn:aws:apigateway:{region}:lambda:path/{service_api}'. Region is used to determine the right endpoint. In this case, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial \/. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations

aIdentityValidationExpression :: Lens' Authorizer (Maybe Text)

A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

aName :: Lens' Authorizer (Maybe Text)

Required

The name of the authorizer.

aId :: Lens' Authorizer (Maybe Text)

The identifier for the authorizer resource.

aAuthorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int)

The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

aAuthType :: Lens' Authorizer (Maybe Text)

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

aType :: Lens' Authorizer (Maybe AuthorizerType)

Required

The type of the authorizer. Currently, the only valid type is TOKEN.

aIdentitySource :: Lens' Authorizer (Maybe Text)

Required

The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.

aAuthorizerCredentials :: Lens' Authorizer (Maybe Text)

Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.