Class Authorizer

Provides an API Gateway Authorizer.

Inheritance

System.Object

Resource

CustomResource

Authorizer

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGateway

Assembly: Pulumi.Aws.dll

Syntax

public class Authorizer : CustomResource

Constructors

Authorizer(String, AuthorizerArgs, CustomResourceOptions)

Create a Authorizer resource with the given unique name, arguments, and options.

Declaration

public Authorizer(string name, AuthorizerArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AuthorizerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AuthorizerCredentials

The credentials required for the authorizer. To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.

Declaration

public Output<string> AuthorizerCredentials { get; }

Property Value

Type	Description
Output<System.String>

AuthorizerResultTtlInSeconds

The TTL of cached authorizer results in seconds. Defaults to 300.

Declaration

public Output<int?> AuthorizerResultTtlInSeconds { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

AuthorizerUri

The authorizer's Uniform Resource Identifier (URI). This must be a well-formed Lambda function URI in the form of arn:aws:apigateway:{region}:lambda:path/{service_api}, e.g. arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations

Declaration

public Output<string> AuthorizerUri { get; }

Property Value

Type	Description
Output<System.String>

IdentitySource

The source of the identity in an incoming request. Defaults to method.request.header.Authorization. For REQUEST type, this may be a comma-separated list of values, including headers, query string parameters and stage variables - e.g. "method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName"

Declaration

public Output<string> IdentitySource { get; }

Property Value

Type	Description
Output<System.String>

IdentityValidationExpression

A validation expression for the incoming identity. For TOKEN type, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

Declaration

public Output<string> IdentityValidationExpression { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the authorizer

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ProviderArns

A list of the Amazon Cognito user pool ARNs. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

Declaration

public Output<ImmutableArray<string>> ProviderArns { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

RestApi

The ID of the associated REST API

Declaration

public Output<string> RestApi { get; }

Property Value

Type	Description
Output<System.String>

Type

The type of the authorizer. Possible 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, or COGNITO_USER_POOLS for using an Amazon Cognito user pool. Defaults to TOKEN.

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, AuthorizerState, CustomResourceOptions)

Get an existing Authorizer resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Authorizer Get(string name, Input<string> id, AuthorizerState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AuthorizerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Authorizer