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

Amazonka.ApiGatewayV2.CreateAuthorizer

Description

Creates an Authorizer for an API.

Synopsis

Creating a Request

data CreateAuthorizer Source #

Creates a new Authorizer resource to represent an authorizer.

See: newCreateAuthorizer smart constructor.

Constructors

CreateAuthorizer' 

Fields

  • authorizerCredentialsArn :: Maybe Text

    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, don't specify this parameter. Supported only for REQUEST authorizers.

  • identityValidationExpression :: Maybe Text

    This parameter is not used.

  • enableSimpleResponses :: Maybe Bool

    Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

  • authorizerUri :: Maybe Text

    The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

  • authorizerPayloadFormatVersion :: Maybe Text

    Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

  • jwtConfiguration :: Maybe JWTConfiguration

    Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

  • authorizerResultTtlInSeconds :: Maybe Natural

    The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

  • apiId :: Text

    The API identifier.

  • authorizerType :: AuthorizerType

    The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

  • identitySource :: [Text]

    The identity source for which authorization is requested.

    For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

  • name :: Text

    The name of the authorizer.

Instances

Instances details
Eq CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Read CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Show CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Generic CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Associated Types

type Rep CreateAuthorizer :: Type -> Type #

NFData CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Methods

rnf :: CreateAuthorizer -> () #

Hashable CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

ToJSON CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

AWSRequest CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Associated Types

type AWSResponse CreateAuthorizer #

ToHeaders CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

ToPath CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

ToQuery CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

type Rep CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

type Rep CreateAuthorizer = D1 ('MetaData "CreateAuthorizer" "Amazonka.ApiGatewayV2.CreateAuthorizer" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "CreateAuthorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authorizerCredentialsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identityValidationExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "enableSimpleResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "authorizerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "authorizerPayloadFormatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "jwtConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JWTConfiguration)) :*: (S1 ('MetaSel ('Just "authorizerResultTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "authorizerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthorizerType) :*: (S1 ('MetaSel ('Just "identitySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateAuthorizer Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

newCreateAuthorizer Source #

Create a value of CreateAuthorizer 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:authorizerCredentialsArn:CreateAuthorizer', createAuthorizer_authorizerCredentialsArn - 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, don't specify this parameter. Supported only for REQUEST authorizers.

$sel:identityValidationExpression:CreateAuthorizer', createAuthorizer_identityValidationExpression - This parameter is not used.

$sel:enableSimpleResponses:CreateAuthorizer', createAuthorizer_enableSimpleResponses - Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

$sel:authorizerUri:CreateAuthorizer', createAuthorizer_authorizerUri - The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

$sel:authorizerPayloadFormatVersion:CreateAuthorizer', createAuthorizer_authorizerPayloadFormatVersion - Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

$sel:jwtConfiguration:CreateAuthorizer', createAuthorizer_jwtConfiguration - Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

$sel:authorizerResultTtlInSeconds:CreateAuthorizer', createAuthorizer_authorizerResultTtlInSeconds - The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

$sel:apiId:CreateAuthorizer', createAuthorizer_apiId - The API identifier.

$sel:authorizerType:CreateAuthorizer', createAuthorizer_authorizerType - The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

$sel:identitySource:CreateAuthorizer', createAuthorizer_identitySource - The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

$sel:name:CreateAuthorizer', createAuthorizer_name - The name of the authorizer.

Request Lenses

createAuthorizer_authorizerCredentialsArn :: 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, don't specify this parameter. Supported only for REQUEST authorizers.

createAuthorizer_enableSimpleResponses :: Lens' CreateAuthorizer (Maybe Bool) Source #

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

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

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

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

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

createAuthorizer_jwtConfiguration :: Lens' CreateAuthorizer (Maybe JWTConfiguration) Source #

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

createAuthorizer_authorizerResultTtlInSeconds :: Lens' CreateAuthorizer (Maybe Natural) Source #

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

createAuthorizer_authorizerType :: Lens' CreateAuthorizer AuthorizerType Source #

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

createAuthorizer_identitySource :: Lens' CreateAuthorizer [Text] Source #

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Destructuring the Response

data CreateAuthorizerResponse Source #

See: newCreateAuthorizerResponse smart constructor.

Constructors

CreateAuthorizerResponse' 

Fields

  • authorizerCredentialsArn :: Maybe Text

    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, don't specify this parameter. Supported only for REQUEST authorizers.

  • identityValidationExpression :: Maybe Text

    The validation expression does not apply to the REQUEST authorizer.

  • enableSimpleResponses :: Maybe Bool

    Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

  • authorizerUri :: Maybe Text

    The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

  • authorizerPayloadFormatVersion :: Maybe Text

    Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

  • jwtConfiguration :: Maybe JWTConfiguration

    Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

  • authorizerId :: Maybe Text

    The authorizer identifier.

  • name :: Maybe Text

    The name of the authorizer.

  • authorizerResultTtlInSeconds :: Maybe Natural

    The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

  • identitySource :: Maybe [Text]

    The identity source for which authorization is requested.

    For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

    For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

  • authorizerType :: Maybe AuthorizerType

    The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateAuthorizerResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Read CreateAuthorizerResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Show CreateAuthorizerResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Generic CreateAuthorizerResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

Associated Types

type Rep CreateAuthorizerResponse :: Type -> Type #

NFData CreateAuthorizerResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

type Rep CreateAuthorizerResponse Source # 
Instance details

Defined in Amazonka.ApiGatewayV2.CreateAuthorizer

type Rep CreateAuthorizerResponse = D1 ('MetaData "CreateAuthorizerResponse" "Amazonka.ApiGatewayV2.CreateAuthorizer" "libZSservicesZSamazonka-apigatewayv2ZSamazonka-apigatewayv2" 'False) (C1 ('MetaCons "CreateAuthorizerResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authorizerCredentialsArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "identityValidationExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enableSimpleResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "authorizerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "authorizerPayloadFormatVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jwtConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JWTConfiguration))))) :*: ((S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "authorizerResultTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: (S1 ('MetaSel ('Just "identitySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "authorizerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateAuthorizerResponse Source #

Create a value of CreateAuthorizerResponse 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:authorizerCredentialsArn:CreateAuthorizer', createAuthorizerResponse_authorizerCredentialsArn - 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, don't specify this parameter. Supported only for REQUEST authorizers.

$sel:identityValidationExpression:CreateAuthorizer', createAuthorizerResponse_identityValidationExpression - The validation expression does not apply to the REQUEST authorizer.

$sel:enableSimpleResponses:CreateAuthorizer', createAuthorizerResponse_enableSimpleResponses - Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

$sel:authorizerUri:CreateAuthorizer', createAuthorizerResponse_authorizerUri - The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

$sel:authorizerPayloadFormatVersion:CreateAuthorizer', createAuthorizerResponse_authorizerPayloadFormatVersion - Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

$sel:jwtConfiguration:CreateAuthorizer', createAuthorizerResponse_jwtConfiguration - Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

$sel:authorizerId:CreateAuthorizerResponse', createAuthorizerResponse_authorizerId - The authorizer identifier.

$sel:name:CreateAuthorizer', createAuthorizerResponse_name - The name of the authorizer.

$sel:authorizerResultTtlInSeconds:CreateAuthorizer', createAuthorizerResponse_authorizerResultTtlInSeconds - The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

$sel:identitySource:CreateAuthorizer', createAuthorizerResponse_identitySource - The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

$sel:authorizerType:CreateAuthorizer', createAuthorizerResponse_authorizerType - The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

$sel:httpStatus:CreateAuthorizerResponse', createAuthorizerResponse_httpStatus - The response's http status code.

Response Lenses

createAuthorizerResponse_authorizerCredentialsArn :: Lens' CreateAuthorizerResponse (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, don't specify this parameter. Supported only for REQUEST authorizers.

createAuthorizerResponse_identityValidationExpression :: Lens' CreateAuthorizerResponse (Maybe Text) Source #

The validation expression does not apply to the REQUEST authorizer.

createAuthorizerResponse_enableSimpleResponses :: Lens' CreateAuthorizerResponse (Maybe Bool) Source #

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

createAuthorizerResponse_authorizerUri :: Lens' CreateAuthorizerResponse (Maybe Text) Source #

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

createAuthorizerResponse_authorizerPayloadFormatVersion :: Lens' CreateAuthorizerResponse (Maybe Text) Source #

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

createAuthorizerResponse_jwtConfiguration :: Lens' CreateAuthorizerResponse (Maybe JWTConfiguration) Source #

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

createAuthorizerResponse_authorizerResultTtlInSeconds :: Lens' CreateAuthorizerResponse (Maybe Natural) Source #

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

createAuthorizerResponse_identitySource :: Lens' CreateAuthorizerResponse (Maybe [Text]) Source #

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

createAuthorizerResponse_authorizerType :: Lens' CreateAuthorizerResponse (Maybe AuthorizerType) Source #

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).