amazonka-apigateway-1.6.0: Amazon API Gateway SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.CreateAuthorizer

Contents

Description

Adds a new Authorizer resource to an existing RestApi resource.

AWS CLI

Synopsis

Creating a Request

createAuthorizer Source #

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:

  • caAuthorizerURI - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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-31functions[FunctionARN]invocations .
  • caIdentityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
  • caProviderARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.
  • caAuthorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is 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.
  • caAuthType - Optional customer-defined field, used in Swagger imports and exports without functional impact.
  • caIdentitySource - The identity source for which authorization is requested. * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . * For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
  • caAuthorizerCredentials - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
  • caRestAPIId - [Required] The string identifier of the associated RestApi .
  • caName - [Required] The name of the authorizer.
  • caType - [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

data CreateAuthorizer Source #

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

See: createAuthorizer smart constructor.

Instances

Eq CreateAuthorizer Source # 
Data CreateAuthorizer Source # 

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 Source # 
Show CreateAuthorizer Source # 
Generic CreateAuthorizer Source # 
Hashable CreateAuthorizer Source # 
ToJSON CreateAuthorizer Source # 
NFData CreateAuthorizer Source # 

Methods

rnf :: CreateAuthorizer -> () #

AWSRequest CreateAuthorizer Source # 
ToHeaders CreateAuthorizer Source # 
ToPath CreateAuthorizer Source # 
ToQuery CreateAuthorizer Source # 
type Rep CreateAuthorizer Source # 
type Rep CreateAuthorizer = D1 * (MetaData "CreateAuthorizer" "Network.AWS.APIGateway.CreateAuthorizer" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "CreateAuthorizer'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_caAuthorizerURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_caIdentityValidationExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_caProviderARNs") 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 "_caIdentitySource") 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)))))))
type Rs CreateAuthorizer Source # 

Request Lenses

caAuthorizerURI :: Lens' CreateAuthorizer (Maybe Text) Source #

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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-31functions[FunctionARN]invocations .

caIdentityValidationExpression :: Lens' CreateAuthorizer (Maybe Text) Source #

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

caProviderARNs :: Lens' CreateAuthorizer [Text] Source #

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.

caAuthorizerResultTtlInSeconds :: Lens' CreateAuthorizer (Maybe Int) Source #

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is 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.

caAuthType :: Lens' CreateAuthorizer (Maybe Text) Source #

Optional customer-defined field, used in Swagger imports and exports without functional impact.

caIdentitySource :: Lens' CreateAuthorizer (Maybe Text) Source #

The identity source for which authorization is requested. * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . * For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

caAuthorizerCredentials :: Lens' CreateAuthorizer (Maybe Text) Source #

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

caRestAPIId :: Lens' CreateAuthorizer Text Source #

Required
The string identifier of the associated RestApi .

caName :: Lens' CreateAuthorizer Text Source #

Required
The name of the authorizer.

caType :: Lens' CreateAuthorizer AuthorizerType Source #

Required
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Destructuring the Response

authorizer :: Authorizer Source #

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 - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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-31functions[FunctionARN]invocations .
  • aIdentityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
  • aProviderARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.
  • aName - [Required] The name of the authorizer.
  • aId - The identifier for the authorizer resource.
  • aAuthorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is 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 - Optional customer-defined field, used in Swagger imports and exports without functional impact.
  • aType - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
  • aIdentitySource - The identity source for which authorization is requested. * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . * For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
  • aAuthorizerCredentials - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

data Authorizer Source #

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

Enable custom authorization

See: authorizer smart constructor.

Instances

Eq Authorizer Source # 
Data Authorizer Source # 

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 Source # 
Show Authorizer Source # 
Generic Authorizer Source # 

Associated Types

type Rep Authorizer :: * -> * #

Hashable Authorizer Source # 
FromJSON Authorizer Source # 
NFData Authorizer Source # 

Methods

rnf :: Authorizer -> () #

type Rep Authorizer Source # 

Response Lenses

aAuthorizerURI :: Lens' Authorizer (Maybe Text) Source #

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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-31functions[FunctionARN]invocations .

aIdentityValidationExpression :: Lens' Authorizer (Maybe Text) Source #

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

aProviderARNs :: Lens' Authorizer [Text] Source #

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.

aName :: Lens' Authorizer (Maybe Text) Source #

Required
The name of the authorizer.

aId :: Lens' Authorizer (Maybe Text) Source #

The identifier for the authorizer resource.

aAuthorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is 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) Source #

Optional customer-defined field, used in Swagger imports and exports without functional impact.

aType :: Lens' Authorizer (Maybe AuthorizerType) Source #

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

aIdentitySource :: Lens' Authorizer (Maybe Text) Source #

The identity source for which authorization is requested. * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . * For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

aAuthorizerCredentials :: Lens' Authorizer (Maybe Text) Source #

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.