Class CfnAuthorizer
A CloudFormation AWS::ApiGatewayV2::Authorizer
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnAuthorizer : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnAuthorizer
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::ApiGatewayV2::Authorizer
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 cfnAuthorizer = new CfnAuthorizer(this, "MyCfnAuthorizer", new CfnAuthorizerProps {
ApiId = "apiId",
AuthorizerType = "authorizerType",
Name = "name",
// the properties below are optional
AuthorizerCredentialsArn = "authorizerCredentialsArn",
AuthorizerPayloadFormatVersion = "authorizerPayloadFormatVersion",
AuthorizerResultTtlInSeconds = 123,
AuthorizerUri = "authorizerUri",
EnableSimpleResponses = false,
IdentitySource = new [] { "identitySource" },
IdentityValidationExpression = "identityValidationExpression",
JwtConfiguration = new JWTConfigurationProperty {
Audience = new [] { "audience" },
Issuer = "issuer"
}
});
Synopsis
Constructors
CfnAuthorizer(Construct, String, ICfnAuthorizerProps) | Create a new |
CfnAuthorizer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAuthorizer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiId | The API identifier. |
AttrAuthorizerId | The authorizer ID. |
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). |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 |
Name | The name of the authorizer. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAuthorizer(Construct, String, ICfnAuthorizerProps)
Create a new AWS::ApiGatewayV2::Authorizer
.
public CfnAuthorizer(Construct scope, string id, ICfnAuthorizerProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnAuthorizerProps
- resource properties.
CfnAuthorizer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAuthorizer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAuthorizer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAuthorizer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiId
The API identifier.
public virtual string ApiId { get; set; }
Property Value
System.String
Remarks
AttrAuthorizerId
The authorizer ID.
public virtual string AttrAuthorizerId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AuthorizerId
AuthorizerCredentialsArn
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
public virtual string AuthorizerCredentialsArn { get; set; }
Property Value
System.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.
AuthorizerPayloadFormatVersion
Specifies the format of the payload sent to an HTTP API Lambda authorizer.
public virtual string AuthorizerPayloadFormatVersion { get; set; }
Property Value
System.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 .
AuthorizerResultTtlInSeconds
The time to live (TTL) for cached authorizer results, in seconds.
public virtual Nullable<double> AuthorizerResultTtlInSeconds { get; set; }
Property Value
System.Nullable<System.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.
AuthorizerType
The authorizer type.
public virtual string AuthorizerType { get; set; }
Property Value
System.String
Remarks
Specify REQUEST
for a Lambda function using incoming request parameters. Specify JWT
to use JSON Web Tokens (supported only for HTTP APIs).
AuthorizerUri
The authorizer's Uniform Resource Identifier (URI).
public virtual string AuthorizerUri { get; set; }
Property Value
System.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
.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EnableSimpleResponses
Specifies whether a Lambda authorizer returns a response in a simple format.
public virtual object EnableSimpleResponses { get; set; }
Property Value
System.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 .
IdentitySource
The identity source for which authorization is requested.
public virtual string[] IdentitySource { get; set; }
Property Value
System.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
.
IdentityValidationExpression
This parameter is not used.
public virtual string IdentityValidationExpression { get; set; }
Property Value
System.String
Remarks
JwtConfiguration
The JWTConfiguration
property specifies the configuration of a JWT authorizer.
public virtual object JwtConfiguration { get; set; }
Property Value
System.Object
Remarks
Required for the JWT
authorizer type. Supported only for HTTP APIs.
Name
The name of the authorizer.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>