Class AuthorizerArgs.Builder

  • Enclosing class:
    AuthorizerArgs

    public static final class AuthorizerArgs.Builder
    extends java.lang.Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • apiId

        public AuthorizerArgs.Builder apiId​(com.pulumi.core.Output<java.lang.String> apiId)
        Parameters:
        apiId - API identifier.
        Returns:
        builder
      • apiId

        public AuthorizerArgs.Builder apiId​(java.lang.String apiId)
        Parameters:
        apiId - API identifier.
        Returns:
        builder
      • authorizerCredentialsArn

        public AuthorizerArgs.Builder authorizerCredentialsArn​(@Nullable
                                                               com.pulumi.core.Output<java.lang.String> authorizerCredentialsArn)
        Parameters:
        authorizerCredentialsArn - Required credentials as an IAM role for API Gateway to invoke the authorizer. Supported only for `REQUEST` authorizers.
        Returns:
        builder
      • authorizerCredentialsArn

        public AuthorizerArgs.Builder authorizerCredentialsArn​(java.lang.String authorizerCredentialsArn)
        Parameters:
        authorizerCredentialsArn - Required credentials as an IAM role for API Gateway to invoke the authorizer. Supported only for `REQUEST` authorizers.
        Returns:
        builder
      • authorizerPayloadFormatVersion

        public AuthorizerArgs.Builder authorizerPayloadFormatVersion​(@Nullable
                                                                     com.pulumi.core.Output<java.lang.String> authorizerPayloadFormatVersion)
        Parameters:
        authorizerPayloadFormatVersion - Format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Valid values: `1.0`, `2.0`.
        Returns:
        builder
      • authorizerPayloadFormatVersion

        public AuthorizerArgs.Builder authorizerPayloadFormatVersion​(java.lang.String authorizerPayloadFormatVersion)
        Parameters:
        authorizerPayloadFormatVersion - Format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Valid values: `1.0`, `2.0`.
        Returns:
        builder
      • authorizerResultTtlInSeconds

        public AuthorizerArgs.Builder authorizerResultTtlInSeconds​(@Nullable
                                                                   com.pulumi.core.Output<java.lang.Integer> authorizerResultTtlInSeconds)
        Parameters:
        authorizerResultTtlInSeconds - 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.
        Returns:
        builder
      • authorizerResultTtlInSeconds

        public AuthorizerArgs.Builder authorizerResultTtlInSeconds​(java.lang.Integer authorizerResultTtlInSeconds)
        Parameters:
        authorizerResultTtlInSeconds - 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.
        Returns:
        builder
      • authorizerType

        public AuthorizerArgs.Builder authorizerType​(com.pulumi.core.Output<java.lang.String> authorizerType)
        Parameters:
        authorizerType - 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.
        Returns:
        builder
      • authorizerType

        public AuthorizerArgs.Builder authorizerType​(java.lang.String authorizerType)
        Parameters:
        authorizerType - 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.
        Returns:
        builder
      • authorizerUri

        public AuthorizerArgs.Builder authorizerUri​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> authorizerUri)
        Parameters:
        authorizerUri - 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.
        Returns:
        builder
      • authorizerUri

        public AuthorizerArgs.Builder authorizerUri​(java.lang.String authorizerUri)
        Parameters:
        authorizerUri - 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.
        Returns:
        builder
      • enableSimpleResponses

        public AuthorizerArgs.Builder enableSimpleResponses​(@Nullable
                                                            com.pulumi.core.Output<java.lang.Boolean> enableSimpleResponses)
        Parameters:
        enableSimpleResponses - 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.
        Returns:
        builder
      • enableSimpleResponses

        public AuthorizerArgs.Builder enableSimpleResponses​(java.lang.Boolean enableSimpleResponses)
        Parameters:
        enableSimpleResponses - 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.
        Returns:
        builder
      • identitySources

        public AuthorizerArgs.Builder identitySources​(@Nullable
                                                      com.pulumi.core.Output<java.util.List<java.lang.String>> identitySources)
        Parameters:
        identitySources - 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.
        Returns:
        builder
      • identitySources

        public AuthorizerArgs.Builder identitySources​(java.util.List<java.lang.String> identitySources)
        Parameters:
        identitySources - 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.
        Returns:
        builder
      • identitySources

        public AuthorizerArgs.Builder identitySources​(java.lang.String... identitySources)
        Parameters:
        identitySources - 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.
        Returns:
        builder
      • jwtConfiguration

        public AuthorizerArgs.Builder jwtConfiguration​(@Nullable
                                                       com.pulumi.core.Output<AuthorizerJwtConfigurationArgs> jwtConfiguration)
        Parameters:
        jwtConfiguration - Configuration of a JWT authorizer. Required for the `JWT` authorizer type. Supported only for HTTP APIs.
        Returns:
        builder
      • jwtConfiguration

        public AuthorizerArgs.Builder jwtConfiguration​(AuthorizerJwtConfigurationArgs jwtConfiguration)
        Parameters:
        jwtConfiguration - Configuration of a JWT authorizer. Required for the `JWT` authorizer type. Supported only for HTTP APIs.
        Returns:
        builder
      • name

        public AuthorizerArgs.Builder name​(@Nullable
                                           com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - Name of the authorizer. Must be between 1 and 128 characters in length.
        Returns:
        builder
      • name

        public AuthorizerArgs.Builder name​(java.lang.String name)
        Parameters:
        name - Name of the authorizer. Must be between 1 and 128 characters in length.
        Returns:
        builder