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
- Struct
- Aws::ApiGatewayV2::Types::GetAuthorizerResponse
- Defined in:
- (unknown)
Overview
Returned by:
Instance Attribute Summary collapse
-
#authorizer_credentials_arn ⇒ String
Represents an Amazon Resource Name (ARN).
.
-
#authorizer_id ⇒ String
The identifier.
.
-
#authorizer_payload_format_version ⇒ String
A string with a length between [1-64].
.
-
#authorizer_result_ttl_in_seconds ⇒ Integer
An integer with a value between [0-3600].
.
-
#authorizer_type ⇒ String
The authorizer type.
-
#authorizer_uri ⇒ String
A string representation of a URI with a length between [1-2048].
.
-
#enable_simple_responses ⇒ Boolean
-
#identity_source ⇒ Array<String>
The identity source for which authorization is requested.
-
#identity_validation_expression ⇒ String
A string with a length between [0-1024].
.
-
#jwt_configuration ⇒ Types::JWTConfiguration
Represents the configuration of a JWT authorizer.
-
#name ⇒ String
A string with a length between [1-128].
.
Instance Attribute Details
#authorizer_credentials_arn ⇒ String
Represents an Amazon Resource Name (ARN).
#authorizer_id ⇒ String
The identifier.
#authorizer_payload_format_version ⇒ String
A string with a length between [1-64].
#authorizer_result_ttl_in_seconds ⇒ Integer
An integer with a value between [0-3600].
#authorizer_type ⇒ String
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).
Possible values:
- REQUEST
- JWT
#authorizer_uri ⇒ String
A string representation of a URI with a length between [1-2048].
#enable_simple_responses ⇒ Boolean
#identity_source ⇒ Array<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.
#identity_validation_expression ⇒ String
A string with a length between [0-1024].
#jwt_configuration ⇒ Types::JWTConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
#name ⇒ String
A string with a length between [1-128].