Package com.pulumi.aws.apigateway.inputs

Class AuthorizerState

  • public final class AuthorizerState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AuthorizerState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the API Gateway Authorizer

      • authorizerCredentials

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerCredentials()
        Returns:
        Credentials required for the authorizer. To specify an IAM Role for API Gateway to assume, use the IAM Role ARN.

      • authorizerResultTtlInSeconds

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> authorizerResultTtlInSeconds()
        Returns:
        TTL of cached authorizer results in seconds. Defaults to `300`.

      • authorizerUri

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerUri()
        Returns:
        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`

      • identitySource

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identitySource()
        Returns:
        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"`

      • identityValidationExpression

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> identityValidationExpression()
        Returns:
        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.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the authorizer

      • providerArns

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> providerArns()
        Returns:
        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}`.

      • restApi

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> restApi()
        Returns:
        ID of the associated REST API

      • type

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> type()
        Returns:
        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`.