Class AuthorizerState

Inheritance
System.Object
InputArgs
ResourceArgs
AuthorizerState
Inherited Members
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 sealed class AuthorizerState : ResourceArgs

Constructors

View Source

AuthorizerState()

Declaration
public AuthorizerState()

Properties

View Source

AuthorizerCredentials

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

Declaration
public Input<string> AuthorizerCredentials { get; set; }
Property Value
Type Description
Input<System.String>
View Source

AuthorizerResultTtlInSeconds

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

Declaration
public Input<int> AuthorizerResultTtlInSeconds { get; set; }
Property Value
Type Description
Input<System.Int32>
View Source

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 Input<string> AuthorizerUri { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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. &quot;method.request.header.SomeHeaderName,method.request.querystring.SomeQueryStringName,stageVariables.SomeStageVariableName&quot;

Declaration
public Input<string> IdentitySource { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> IdentityValidationExpression { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Name

The name of the authorizer

Declaration
public Input<string> Name { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 InputList<string> ProviderArns { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

RestApi

The ID of the associated REST API

Declaration
public Input<string> RestApi { get; set; }
Property Value
Type Description
Input<System.String>
View Source

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 Input<string> Type { get; set; }
Property Value
Type Description
Input<System.String>