Class CfnAuthorizerMixinProps

Properties for CfnAuthorizerPropsMixin.

Inheritance

object

CfnAuthorizerMixinProps

Implements

ICfnAuthorizerMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnAuthorizerMixinProps : ICfnAuthorizerMixinProps

Syntax (vb)

Public Class CfnAuthorizerMixinProps Implements ICfnAuthorizerMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html

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.Mixins.Preview.AWS.ApiGatewayV2.Mixins;

             var cfnAuthorizerMixinProps = new CfnAuthorizerMixinProps {
                 ApiId = "apiId",
                 AuthorizerCredentialsArn = "authorizerCredentialsArn",
                 AuthorizerPayloadFormatVersion = "authorizerPayloadFormatVersion",
                 AuthorizerResultTtlInSeconds = 123,
                 AuthorizerType = "authorizerType",
                 AuthorizerUri = "authorizerUri",
                 EnableSimpleResponses = false,
                 IdentitySource = new [] { "identitySource" },
                 IdentityValidationExpression = "identityValidationExpression",
                 JwtConfiguration = new JWTConfigurationProperty {
                     Audience = new [] { "audience" },
                     Issuer = "issuer"
                 },
                 Name = "name"
             };

Synopsis

Constructors

CfnAuthorizerMixinProps()

Properties for CfnAuthorizerPropsMixin.

Properties

ApiId	The API identifier.
AuthorizerCredentialsArn	Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
AuthorizerPayloadFormatVersion	Specifies the format of the payload sent to an HTTP API Lambda authorizer.
AuthorizerResultTtlInSeconds	The time to live (TTL) for cached authorizer results, in seconds.
AuthorizerType	The authorizer type.
AuthorizerUri	The authorizer's Uniform Resource Identifier (URI).
EnableSimpleResponses	Specifies whether a Lambda authorizer returns a response in a simple format.
IdentitySource	The identity source for which authorization is requested.
IdentityValidationExpression	This parameter is not used.
JwtConfiguration	The JWTConfiguration property specifies the configuration of a JWT authorizer.
Name	The name of the authorizer.

Constructors

CfnAuthorizerMixinProps()

Properties for CfnAuthorizerPropsMixin.

public CfnAuthorizerMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html

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.Mixins.Preview.AWS.ApiGatewayV2.Mixins;

             var cfnAuthorizerMixinProps = new CfnAuthorizerMixinProps {
                 ApiId = "apiId",
                 AuthorizerCredentialsArn = "authorizerCredentialsArn",
                 AuthorizerPayloadFormatVersion = "authorizerPayloadFormatVersion",
                 AuthorizerResultTtlInSeconds = 123,
                 AuthorizerType = "authorizerType",
                 AuthorizerUri = "authorizerUri",
                 EnableSimpleResponses = false,
                 IdentitySource = new [] { "identitySource" },
                 IdentityValidationExpression = "identityValidationExpression",
                 JwtConfiguration = new JWTConfigurationProperty {
                     Audience = new [] { "audience" },
                     Issuer = "issuer"
                 },
                 Name = "name"
             };

Properties

ApiId

The API identifier.

public string? ApiId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid

AuthorizerCredentialsArn

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.

public string? AuthorizerCredentialsArn { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn

AuthorizerPayloadFormatVersion

Specifies the format of the payload sent to an HTTP API Lambda authorizer.

public string? AuthorizerPayloadFormatVersion { get; set; }

Property Value

string

Remarks

Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0 . To learn more, see Working with AWS Lambda authorizers for HTTP APIs .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerpayloadformatversion

AuthorizerResultTtlInSeconds

The time to live (TTL) for cached authorizer results, in seconds.

public double? AuthorizerResultTtlInSeconds { get; set; }

Property Value

double?

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds

AuthorizerType

The authorizer type.

public string? AuthorizerType { get; set; }

Property Value

string

Remarks

Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype

AuthorizerUri

The authorizer's Uniform Resource Identifier (URI).

public string? AuthorizerUri { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri

EnableSimpleResponses

Specifies whether a Lambda authorizer returns a response in a simple format.

public object? EnableSimpleResponses { get; set; }

Property Value

object

Remarks

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 AWS Lambda authorizers for HTTP APIs .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-enablesimpleresponses

Type union: either bool or IResolvable

IdentitySource

The identity source for which authorization is requested.

public string[]? IdentitySource { get; set; }

Property Value

string[]

Remarks

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 AWS Lambda authorizers for HTTP APIs .

For JWT , 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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource

IdentityValidationExpression

This parameter is not used.

public string? IdentityValidationExpression { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression

JwtConfiguration

The JWTConfiguration property specifies the configuration of a JWT authorizer.

public object? JwtConfiguration { get; set; }

Property Value

object

Remarks

Required for the JWT authorizer type. Supported only for HTTP APIs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration

Type union: either IResolvable or CfnAuthorizerPropsMixin.IJWTConfigurationProperty

Name

The name of the authorizer.

public string? Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name

Implements

ICfnAuthorizerMixinProps