Class HttpUserPoolAuthorizerProps
(experimental) Properties to initialize HttpUserPoolAuthorizer.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.APIGatewayv2.Authorizers
Assembly: Amazon.CDK.AWS.APIGatewayv2.Authorizers.dll
Syntax (csharp)
public class HttpUserPoolAuthorizerProps : Object, IHttpUserPoolAuthorizerProps
Syntax (vb)
Public Class HttpUserPoolAuthorizerProps
Inherits Object
Implements IHttpUserPoolAuthorizerProps
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2.Authorizers;
using Amazon.CDK.AWS.Cognito;
UserPoolClient userPoolClient;
var httpUserPoolAuthorizerProps = new HttpUserPoolAuthorizerProps {
AuthorizerName = "authorizerName",
IdentitySource = new [] { "identitySource" },
UserPoolClients = new [] { userPoolClient },
UserPoolRegion = "userPoolRegion"
};
Synopsis
Constructors
HttpUserPoolAuthorizerProps() |
Properties
AuthorizerName | (experimental) Friendly name of the authorizer. |
IdentitySource | (experimental) The identity source for which authorization is requested. |
UserPoolClients | (experimental) The user pool clients that should be used to authorize requests with the user pool. |
UserPoolRegion | (experimental) The AWS region in which the user pool is present. |
Constructors
HttpUserPoolAuthorizerProps()
public HttpUserPoolAuthorizerProps()
Properties
AuthorizerName
(experimental) Friendly name of the authorizer.
public string AuthorizerName { get; set; }
Property Value
System.String
Remarks
Default: - same value as id
passed in the constructor
Stability: Experimental
IdentitySource
(experimental) The identity source for which authorization is requested.
public string[] IdentitySource { get; set; }
Property Value
System.String[]
Remarks
Default: ['$request.header.Authorization']
Stability: Experimental
UserPoolClients
(experimental) The user pool clients that should be used to authorize requests with the user pool.
public IUserPoolClient[] UserPoolClients { get; set; }
Property Value
Remarks
Default: - a new client will be created for the given user pool
Stability: Experimental
UserPoolRegion
(experimental) The AWS region in which the user pool is present.
public string UserPoolRegion { get; set; }
Property Value
System.String
Remarks
Default: - same region as the Route the authorizer is attached to.
Stability: Experimental