AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ApiGatewayV2::Types::Authorizer

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents an authorizer.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorizer_credentials_arnString

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.

Returns:

  • (String)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_idString

The authorizer identifier.

Returns:

  • (String)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_payload_format_versionString

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.

Returns:

  • (String)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_result_ttl_in_secondsInteger

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.

Returns:

  • (Integer)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_typeString

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

Returns:

  • (String)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_uriString

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.

Returns:

  • (String)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#enable_simple_responsesBoolean

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

Returns:

  • (Boolean)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#identity_sourceArray<String>

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.

Returns:

  • (Array<String>)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#identity_validation_expressionString

The validation expression does not apply to the REQUEST authorizer.

Returns:

  • (String)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#jwt_configurationTypes::JWTConfiguration

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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the authorizer.

Returns:

  • (String)


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 331

class Authorizer < Struct.new(
  :authorizer_credentials_arn,
  :authorizer_id,
  :authorizer_result_ttl_in_seconds,
  :authorizer_type,
  :authorizer_uri,
  :identity_source,
  :identity_validation_expression,
  :jwt_configuration,
  :name,
  :authorizer_payload_format_version,
  :enable_simple_responses)
  SENSITIVE = []
  include Aws::Structure
end