We recommend new projects start with resources from the AWS provider.
aws-native.apigatewayv2.Authorizer
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::ApiGatewayV2::Authorizer
resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see Controlling and managing access to a WebSocket API in API Gateway and Controlling and managing access to an HTTP API in API Gateway in the API Gateway Developer Guide.
Create Authorizer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Authorizer(name: string, args: AuthorizerArgs, opts?: CustomResourceOptions);
@overload
def Authorizer(resource_name: str,
args: AuthorizerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Authorizer(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
authorizer_type: Optional[str] = None,
authorizer_credentials_arn: Optional[str] = None,
authorizer_payload_format_version: Optional[str] = None,
authorizer_result_ttl_in_seconds: Optional[int] = None,
authorizer_uri: Optional[str] = None,
enable_simple_responses: Optional[bool] = None,
identity_source: Optional[Sequence[str]] = None,
identity_validation_expression: Optional[str] = None,
jwt_configuration: Optional[AuthorizerJwtConfigurationArgs] = None,
name: Optional[str] = None)
func NewAuthorizer(ctx *Context, name string, args AuthorizerArgs, opts ...ResourceOption) (*Authorizer, error)
public Authorizer(string name, AuthorizerArgs args, CustomResourceOptions? opts = null)
public Authorizer(String name, AuthorizerArgs args)
public Authorizer(String name, AuthorizerArgs args, CustomResourceOptions options)
type: aws-native:apigatewayv2:Authorizer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AuthorizerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AuthorizerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AuthorizerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthorizerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AuthorizerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Authorizer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Authorizer resource accepts the following input properties:
- Api
Id string - The API identifier.
- string
- The authorizer type. Specify
REQUEST
for a Lambda function using incoming request parameters. SpecifyJWT
to use JSON Web Tokens (supported only for HTTP APIs). - string
- 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. - string
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are
1.0
and2.0
. To learn more, see Working with Lambda authorizers for HTTP APIs. - int
- 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.
- string
- 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
. - Enable
Simple boolResponses - Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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 Lambda authorizers for HTTP APIs.
- Identity
Source List<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 Lambda authorizers for HTTP APIs. ForJWT
, 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
. - Identity
Validation stringExpression - This parameter is not used.
- Jwt
Configuration Pulumi.Aws Native. Api Gateway V2. Inputs. Authorizer Jwt Configuration - The
JWTConfiguration
property specifies the configuration of a JWT authorizer. Required for theJWT
authorizer type. Supported only for HTTP APIs. - Name string
- The name of the authorizer.
- Api
Id string - The API identifier.
- string
- The authorizer type. Specify
REQUEST
for a Lambda function using incoming request parameters. SpecifyJWT
to use JSON Web Tokens (supported only for HTTP APIs). - string
- 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. - string
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are
1.0
and2.0
. To learn more, see Working with Lambda authorizers for HTTP APIs. - int
- 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.
- string
- 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
. - Enable
Simple boolResponses - Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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 Lambda authorizers for HTTP APIs.
- Identity
Source []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 Lambda authorizers for HTTP APIs. ForJWT
, 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
. - Identity
Validation stringExpression - This parameter is not used.
- Jwt
Configuration AuthorizerJwt Configuration Args - The
JWTConfiguration
property specifies the configuration of a JWT authorizer. Required for theJWT
authorizer type. Supported only for HTTP APIs. - Name string
- The name of the authorizer.
- api
Id String - The API identifier.
- String
- The authorizer type. Specify
REQUEST
for a Lambda function using incoming request parameters. SpecifyJWT
to use JSON Web Tokens (supported only for HTTP APIs). - String
- 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. - String
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are
1.0
and2.0
. To learn more, see Working with Lambda authorizers for HTTP APIs. - Integer
- 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.
- String
- 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
. - enable
Simple BooleanResponses - Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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 Lambda authorizers for HTTP APIs.
- identity
Source List<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 Lambda authorizers for HTTP APIs. ForJWT
, 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
. - identity
Validation StringExpression - This parameter is not used.
- jwt
Configuration AuthorizerJwt Configuration - The
JWTConfiguration
property specifies the configuration of a JWT authorizer. Required for theJWT
authorizer type. Supported only for HTTP APIs. - name String
- The name of the authorizer.
- api
Id string - The API identifier.
- string
- The authorizer type. Specify
REQUEST
for a Lambda function using incoming request parameters. SpecifyJWT
to use JSON Web Tokens (supported only for HTTP APIs). - string
- 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. - string
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are
1.0
and2.0
. To learn more, see Working with Lambda authorizers for HTTP APIs. - number
- 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.
- string
- 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
. - enable
Simple booleanResponses - Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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 Lambda authorizers for HTTP APIs.
- identity
Source 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 Lambda authorizers for HTTP APIs. ForJWT
, 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
. - identity
Validation stringExpression - This parameter is not used.
- jwt
Configuration AuthorizerJwt Configuration - The
JWTConfiguration
property specifies the configuration of a JWT authorizer. Required for theJWT
authorizer type. Supported only for HTTP APIs. - name string
- The name of the authorizer.
- api_
id str - The API identifier.
- str
- The authorizer type. Specify
REQUEST
for a Lambda function using incoming request parameters. SpecifyJWT
to use JSON Web Tokens (supported only for HTTP APIs). - str
- 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. - str
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are
1.0
and2.0
. To learn more, see Working with Lambda authorizers for HTTP APIs. - int
- 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.
- str
- 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
. - enable_
simple_ boolresponses - Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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 Lambda authorizers for HTTP APIs.
- identity_
source Sequence[str] - 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 Lambda authorizers for HTTP APIs. ForJWT
, 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
. - identity_
validation_ strexpression - This parameter is not used.
- jwt_
configuration AuthorizerJwt Configuration Args - The
JWTConfiguration
property specifies the configuration of a JWT authorizer. Required for theJWT
authorizer type. Supported only for HTTP APIs. - name str
- The name of the authorizer.
- api
Id String - The API identifier.
- String
- The authorizer type. Specify
REQUEST
for a Lambda function using incoming request parameters. SpecifyJWT
to use JSON Web Tokens (supported only for HTTP APIs). - String
- 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. - String
- Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are
1.0
and2.0
. To learn more, see Working with Lambda authorizers for HTTP APIs. - Number
- 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.
- String
- 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
. - enable
Simple BooleanResponses - Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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 Lambda authorizers for HTTP APIs.
- identity
Source List<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 Lambda authorizers for HTTP APIs. ForJWT
, 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
. - identity
Validation StringExpression - This parameter is not used.
- jwt
Configuration Property Map - The
JWTConfiguration
property specifies the configuration of a JWT authorizer. Required for theJWT
authorizer type. Supported only for HTTP APIs. - name String
- The name of the authorizer.
Outputs
All input properties are implicitly available as output properties. Additionally, the Authorizer resource produces the following output properties:
- string
- The authorizer ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- string
- The authorizer ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- String
- The authorizer ID.
- id String
- The provider-assigned unique ID for this managed resource.
- string
- The authorizer ID.
- id string
- The provider-assigned unique ID for this managed resource.
- str
- The authorizer ID.
- id str
- The provider-assigned unique ID for this managed resource.
- String
- The authorizer ID.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
AuthorizerJwtConfiguration, AuthorizerJwtConfigurationArgs
- Audience List<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. Required for theJWT
authorizer type. Supported only for HTTP APIs. - Issuer string
- 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 theJWT
authorizer type. Supported only for HTTP APIs.
- Audience []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. Required for theJWT
authorizer type. Supported only for HTTP APIs. - Issuer string
- 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 theJWT
authorizer type. Supported only for HTTP APIs.
- audience List<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. Required for theJWT
authorizer type. Supported only for HTTP APIs. - issuer String
- 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 theJWT
authorizer type. Supported only for HTTP APIs.
- audience 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. Required for theJWT
authorizer type. Supported only for HTTP APIs. - issuer string
- 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 theJWT
authorizer type. Supported only for HTTP APIs.
- audience Sequence[str]
- 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. Required for theJWT
authorizer type. Supported only for HTTP APIs. - issuer str
- 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 theJWT
authorizer type. Supported only for HTTP APIs.
- audience List<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. Required for theJWT
authorizer type. Supported only for HTTP APIs. - issuer String
- 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 theJWT
authorizer type. Supported only for HTTP APIs.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.