Show / Hide Table of Contents

Class HttpRouteAuthorizerConfig

(experimental) Results of binding an authorizer to an http route.

Inheritance
System.Object
HttpRouteAuthorizerConfig
Implements
IHttpRouteAuthorizerConfig
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class HttpRouteAuthorizerConfig : Object, IHttpRouteAuthorizerConfig
Syntax (vb)
Public Class HttpRouteAuthorizerConfig
    Inherits Object
    Implements IHttpRouteAuthorizerConfig
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;

var httpRouteAuthorizerConfig = new HttpRouteAuthorizerConfig {
    AuthorizationType = "authorizationType",

    // the properties below are optional
    AuthorizationScopes = new [] { "authorizationScopes" },
    AuthorizerId = "authorizerId"
};

Synopsis

Constructors

HttpRouteAuthorizerConfig()

Properties

AuthorizationScopes

(experimental) The list of OIDC scopes to include in the authorization.

AuthorizationType

(experimental) The type of authorization.

AuthorizerId

(experimental) The authorizer id.

Constructors

HttpRouteAuthorizerConfig()

public HttpRouteAuthorizerConfig()

Properties

AuthorizationScopes

(experimental) The list of OIDC scopes to include in the authorization.

public string[] AuthorizationScopes { get; set; }
Property Value

System.String[]

Remarks

Default: - no authorization scopes

Stability: Experimental

AuthorizationType

(experimental) The type of authorization.

public string AuthorizationType { get; set; }
Property Value

System.String

Remarks

Possible values are:

    Stability: Experimental

    AuthorizerId

    (experimental) The authorizer id.

    public string AuthorizerId { get; set; }
    Property Value

    System.String

    Remarks

    Default: - No authorizer id (useful for AWS_IAM route authorizer)

    Stability: Experimental

    Implements

    IHttpRouteAuthorizerConfig
    Back to top Generated by DocFX