Class CfnAuthorizer
- Namespace
- Amazon.CDK.AWS.APIGateway
- Assembly
- Amazon.CDK.AWS.APIGateway.dll
A CloudFormation AWS::ApiGateway::Authorizer.
public class CfnAuthorizer : CfnResource, IInspectable- Inheritance
-
CfnAuthorizer
- Implements
-
IInspectable
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;
var cfnAuthorizer = new CfnAuthorizer(this, "MyCfnAuthorizer", new CfnAuthorizerProps {
Name = "name",
RestApiId = "restApiId",
Type = "type",
// the properties below are optional
AuthorizerCredentials = "authorizerCredentials",
AuthorizerResultTtlInSeconds = 123,
AuthorizerUri = "authorizerUri",
AuthType = "authType",
IdentitySource = "identitySource",
IdentityValidationExpression = "identityValidationExpression",
ProviderArns = new [] { "providerArns" }
});Remarks
The AWS::ApiGateway::Authorizer resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
CloudformationResource: AWS::ApiGateway::Authorizer
ExampleMetadata: fixture=_generated
Constructors
CfnAuthorizer(Construct, string, ICfnAuthorizerProps)
Create a new AWS::ApiGateway::Authorizer.
public CfnAuthorizer(Construct scope, string id, ICfnAuthorizerProps props)Parameters
scopeConstruct- scope in which this resource is defined.
idstring- scoped id of the resource.
propsICfnAuthorizerProps- resource properties.
Properties
AttrAuthorizerId
The ID for the authorizer.
public virtual string AttrAuthorizerId { get; }Property Value
Remarks
For example: abc123 .
CloudformationAttribute: AuthorizerId
AuthType
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
public virtual string? AuthType { get; set; }Property Value
Remarks
AuthorizerCredentials
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
public virtual string? AuthorizerCredentials { get; set; }Property Value
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.
AuthorizerResultTtlInSeconds
The TTL in seconds of cached authorizer results.
public virtual double? AuthorizerResultTtlInSeconds { get; set; }Property Value
Remarks
If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
AuthorizerUri
Specifies the authorizer's Uniform Resource Identifier (URI).
public virtual string? AuthorizerUri { get; set; }Property Value
Remarks
For TOKEN or 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
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
IdentitySource
The identity source for which authorization is requested.
public virtual string? IdentitySource { get; set; }Property Value
Remarks
For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
IdentityValidationExpression
A validation expression for the incoming identity token.
public virtual string? IdentityValidationExpression { get; set; }Property Value
Remarks
For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
Name
The name of the authorizer.
public virtual string Name { get; set; }Property Value
Remarks
ProviderArns
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
public virtual string[]? ProviderArns { get; set; }Property Value
- string[]
Remarks
Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.
RestApiId
The string identifier of the associated RestApi.
public virtual string RestApiId { get; set; }Property Value
Remarks
Type
The authorizer type.
public virtual string Type { get; set; }Property Value
Remarks
Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
inspectorTreeInspector- tree inspector to collect and process attributes.
RenderProperties(IDictionary<string, object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
propsIDictionary<string, object>