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.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::CreateAuthorizerInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents the input parameters for a CreateAuthorizer request.

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, specify null. Supported only for REQUEST authorizers.

Returns:

  • (String)

    Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

#authorizer_result_ttl_in_secondsInteger

Authorizer caching is not currently supported. Don\'t specify this value for authorizers.

Returns:

  • (Integer)

    Authorizer caching is not currently supported.

#authorizer_typeString

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

Possible values:

  • REQUEST
  • JWT

Returns:

  • (String)

    The authorizer type.

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

    The authorizer\'s Uniform Resource Identifier (URI).

#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. Currently, 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. These parameters will be 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 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>)

    The identity source for which authorization is requested.

#identity_validation_expressionString

This parameter is not used.

Returns:

  • (String)

    This parameter is not used.

#jwt_configurationTypes::JWTConfiguration

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

Returns:

#nameString

The name of the authorizer.

Returns:

  • (String)

    The name of the authorizer.