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

Class: Aws::ApiGatewayV2::Types::GetAuthorizerResponse

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

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#authorizer_credentials_arnString

Represents an Amazon Resource Name (ARN).

Returns:

  • (String)

    Represents an Amazon Resource Name (ARN).

    .

#authorizer_idString

The identifier.

Returns:

  • (String)

    The identifier.

    .

#authorizer_result_ttl_in_secondsInteger

An integer with a value between [0-3600].

Returns:

  • (Integer)

    An integer with a value between [0-3600].

    .

#authorizer_typeString

The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.

Possible values:

  • REQUEST

Returns:

  • (String)

    The authorizer type.

#authorizer_uriString

A string representation of a URI with a length between [1-2048].

Returns:

  • (String)

    A string representation of a URI with a length between [1-2048].

    .

#identity_sourceArray<String>

The identity source for which authorization is requested. 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.

Returns:

  • (Array<String>)

    The identity source for which authorization is requested.

#identity_validation_expressionString

A string with a length between [0-1024].

Returns:

  • (String)

    A string with a length between [0-1024].

    .

#nameString

A string with a length between [1-128].

Returns:

  • (String)

    A string with a length between [1-128].

    .

#provider_arnsArray<String>

For REQUEST authorizer, this is not defined.

Returns:

  • (Array<String>)

    For REQUEST authorizer, this is not defined.

    .