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::JWTConfiguration

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

Overview

Note:

When making an API call, you may pass JWTConfiguration data as a hash:

{
  audience: ["__string"],
  issuer: "UriWithLengthBetween1And2048",
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audienceArray<String>

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

Returns:

  • (Array<String>)


5705
5706
5707
5708
5709
5710
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5705

class JWTConfiguration < Struct.new(
  :audience,
  :issuer)
  SENSITIVE = []
  include Aws::Structure
end

#issuerString

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.*\{region\}.amazonaws.com/{userPoolId\}* . Required for the JWT authorizer type. Supported only for HTTP APIs.

Returns:

  • (String)


5705
5706
5707
5708
5709
5710
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5705

class JWTConfiguration < Struct.new(
  :audience,
  :issuer)
  SENSITIVE = []
  include Aws::Structure
end