RequestValidator class
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/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_requestvalidator" "example" {
name = "example"
rest_api = exampleAwsApiGatewayRestApi.id
validate_request_body = true
validate_request_parameters = true
}
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.ArrayList;
import java.util.Arrays;
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.apigateway.RequestValidator using REST-API-ID/REQUEST-VALIDATOR-ID. For example:
$ pulumi import aws:apigateway/requestValidator:RequestValidator example 12345abcde/67890fghij
Constructors
- RequestValidator(String name, {RequestValidatorArgs? args, CustomResourceOptions? options})
-
Creates a new RequestValidator.
nameThe Pulumi resource name.argsArguments used to configure this RequestValidator. The set of arguments for RequestValidator.optionsResource options controlling this resource's behavior. - RequestValidator.reference(String urn)
- Creates a typed reference to an existing RequestValidator resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the request validator
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
restApi
↔ Output<
String> -
ID of the associated Rest API
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
validateRequestBody
↔ Output<
bool?> -
Boolean whether to validate request body. Defaults to
false.latefinal -
validateRequestParameters
↔ Output<
bool?> -
Boolean whether to validate request parameters. Defaults to
false.latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {RequestValidatorState? state, CustomResourceOptions? options}) → RequestValidator -
Gets an existing RequestValidator resource's state with the given
nameandid.