@aws-cdk_aws-apigatewayv2-authorizers-alpha.HttpUserPoolAuthorizerProps

interface HttpUserPoolAuthorizerProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Authorizers.Alpha.HttpUserPoolAuthorizerProps
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2authorizersalpha/v2#HttpUserPoolAuthorizerProps
Javasoftware.amazon.awscdk.services.apigatewayv2.authorizers.alpha.HttpUserPoolAuthorizerProps
Pythonaws_cdk.aws_apigatewayv2_authorizers_alpha.HttpUserPoolAuthorizerProps
TypeScript (source)@aws-cdk/aws-apigatewayv2-authorizers-alpha ยป HttpUserPoolAuthorizerProps

Properties to initialize HttpUserPoolAuthorizer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigatewayv2_authorizers_alpha from '@aws-cdk/aws-apigatewayv2-authorizers-alpha';
import { aws_cognito as cognito } from 'aws-cdk-lib';

declare const userPoolClient: cognito.UserPoolClient;
const httpUserPoolAuthorizerProps: apigatewayv2_authorizers_alpha.HttpUserPoolAuthorizerProps = {
  authorizerName: 'authorizerName',
  identitySource: ['identitySource'],
  userPoolClients: [userPoolClient],
  userPoolRegion: 'userPoolRegion',
};

Properties

NameTypeDescription
authorizerName?๐Ÿ”นstringFriendly name of the authorizer.
identitySource?๐Ÿ”นstring[]The identity source for which authorization is requested.
userPoolClients?๐Ÿ”นIUserPoolClient[]The user pool clients that should be used to authorize requests with the user pool.
userPoolRegion?๐Ÿ”นstringThe AWS region in which the user pool is present.

authorizerName?๐Ÿ”น

Type: string (optional, default: same value as id passed in the constructor)

Friendly name of the authorizer.


identitySource?๐Ÿ”น

Type: string[] (optional, default: ['$request.header.Authorization'])

The identity source for which authorization is requested.


userPoolClients?๐Ÿ”น

Type: IUserPoolClient[] (optional, default: a new client will be created for the given user pool)

The user pool clients that should be used to authorize requests with the user pool.


userPoolRegion?๐Ÿ”น

Type: string (optional, default: same region as the Route the authorizer is attached to.)

The AWS region in which the user pool is present.