Class RequestValidator

Manages an API Gateway Request Validator.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.ApiGateway.RequestValidator("example", new Aws.ApiGateway.RequestValidatorArgs
    {
        RestApi = aws_api_gateway_rest_api.Example.Id,
        ValidateRequestBody = true,
        ValidateRequestParameters = true,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

RequestValidator

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGateway

Assembly: Pulumi.Aws.dll

Syntax

public class RequestValidator : CustomResource

Constructors

RequestValidator(String, RequestValidatorArgs, CustomResourceOptions)

Create a RequestValidator resource with the given unique name, arguments, and options.

Declaration

public RequestValidator(string name, RequestValidatorArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RequestValidatorArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Name

The name of the request validator

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

RestApi

The ID of the associated Rest API

Declaration

public Output<string> RestApi { get; }

Property Value

Type	Description
Output<System.String>

ValidateRequestBody

Boolean whether to validate request body. Defaults to false.

Declaration

public Output<bool?> ValidateRequestBody { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

ValidateRequestParameters

Boolean whether to validate request parameters. Defaults to false.

Declaration

public Output<bool?> ValidateRequestParameters { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

Get(String, Input<String>, RequestValidatorState, CustomResourceOptions)

Get an existing RequestValidator resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static RequestValidator Get(string name, Input<string> id, RequestValidatorState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RequestValidatorState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
RequestValidator