Package com.pulumi.aws.apigatewayv2.inputs

Class AuthorizerState

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

    • Method Detail

      • apiId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> apiId()
        Returns:
        API identifier.

      • authorizerCredentialsArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerCredentialsArn()
        Returns:
        Required credentials as an IAM role for API Gateway to invoke the authorizer. Supported only for `REQUEST` authorizers.

      • authorizerPayloadFormatVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerPayloadFormatVersion()
        Returns:
        Format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Valid values: `1.0`, `2.0`.

      • authorizerResultTtlInSeconds

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> authorizerResultTtlInSeconds()
        Returns:
        Time to live (TTL) for cached authorizer results, in seconds. 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. Defaults to `300`. Supported only for HTTP API Lambda authorizers.

      • authorizerType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerType()
        Returns:
        Authorizer type. Valid values: `JWT`, `REQUEST`. Specify `REQUEST` for a Lambda function using incoming request parameters. For HTTP APIs, specify `JWT` to use JSON Web Tokens.

      • authorizerUri

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authorizerUri()
        Returns:
        Authorizer's Uniform Resource Identifier (URI). For `REQUEST` authorizers this must be a well-formed Lambda function URI, such as the `invoke_arn` attribute of the `aws.lambda.Function` resource. Supported only for `REQUEST` authorizers. Must be between 1 and 2048 characters in length.

      • enableSimpleResponses

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableSimpleResponses()
        Returns:
        Whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs.

      • identitySources

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> identitySources()
        Returns:
        Identity sources for which authorization is requested. For `REQUEST` authorizers the value is a list of one or more mapping expressions of the specified request parameters. For `JWT` authorizers the single entry specifies where to extract the JSON Web Token (JWT) from inbound requests.

      • jwtConfiguration

        public java.util.Optional<com.pulumi.core.Output<AuthorizerJwtConfigurationArgs>> jwtConfiguration()
        Returns:
        Configuration of a JWT authorizer. Required for the `JWT` authorizer type. Supported only for HTTP APIs.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the authorizer. Must be between 1 and 128 characters in length.