RequestValidatorArgs

data class RequestValidatorArgs(val name: Output<String>? = null, val restApi: Output<String>? = null, val validateRequestBody: Output<Boolean>? = null, val validateRequestParameters: Output<Boolean>? = null) : ConvertibleToJava<RequestValidatorArgs>

Manages an API Gateway Request Validator.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigateway.RequestValidator("example", {
name: "example",
restApi: exampleAwsApiGatewayRestApi.id,
validateRequestBody: true,
validateRequestParameters: true,
});
import pulumi
import pulumi_aws as aws
example = aws.apigateway.RequestValidator("example",
name="example",
rest_api=example_aws_api_gateway_rest_api["id"],
validate_request_body=True,
validate_request_parameters=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGateway.RequestValidator("example", new()
{
Name = "example",
RestApi = exampleAwsApiGatewayRestApi.Id,
ValidateRequestBody = true,
ValidateRequestParameters = true,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.NewRequestValidator(ctx, "example", &apigateway.RequestValidatorArgs{
Name: pulumi.String("example"),
RestApi: pulumi.Any(exampleAwsApiGatewayRestApi.Id),
ValidateRequestBody: pulumi.Bool(true),
ValidateRequestParameters: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.RequestValidator;
import com.pulumi.aws.apigateway.RequestValidatorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new RequestValidator("example", RequestValidatorArgs.builder()
.name("example")
.restApi(exampleAwsApiGatewayRestApi.id())
.validateRequestBody(true)
.validateRequestParameters(true)
.build());
}
}
resources:
example:
type: aws:apigateway:RequestValidator
properties:
name: example
restApi: ${exampleAwsApiGatewayRestApi.id}
validateRequestBody: true
validateRequestParameters: true

Import

Using pulumi import, import aws_api_gateway_request_validator using REST-API-ID/REQUEST-VALIDATOR-ID. For example:

$ pulumi import aws:apigateway/requestValidator:RequestValidator example 12345abcde/67890fghij

Constructors

Link copied to clipboard
constructor(name: Output<String>? = null, restApi: Output<String>? = null, validateRequestBody: Output<Boolean>? = null, validateRequestParameters: Output<Boolean>? = null)

Properties

Link copied to clipboard
val name: Output<String>? = null

Name of the request validator

Link copied to clipboard
val restApi: Output<String>? = null

ID of the associated Rest API

Link copied to clipboard
val validateRequestBody: Output<Boolean>? = null

Boolean whether to validate request body. Defaults to false.

Link copied to clipboard
val validateRequestParameters: Output<Boolean>? = null

Boolean whether to validate request parameters. Defaults to false.

Functions

Link copied to clipboard
open override fun toJava(): RequestValidatorArgs