← All packages

AWS Native

Pulumi Official

Package maintained by Pulumi

v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

Source code

RequestValidator

Resource Type definition for AWS::ApiGateway::RequestValidator

Create a RequestValidator Resource

new RequestValidator(name: string, args: RequestValidatorArgs, opts?: CustomResourceOptions);

@overload
def RequestValidator(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     name: Optional[str] = None,
                     rest_api_id: Optional[str] = None,
                     validate_request_body: Optional[bool] = None,
                     validate_request_parameters: Optional[bool] = None)
@overload
def RequestValidator(resource_name: str,
                     args: RequestValidatorArgs,
                     opts: Optional[ResourceOptions] = None)

func NewRequestValidator(ctx *Context, name string, args RequestValidatorArgs, opts ...ResourceOption) (*RequestValidator, error)

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

public RequestValidator(String name, RequestValidatorArgs args)
public RequestValidator(String name, RequestValidatorArgs args, CustomResourceOptions options)

type: aws-native:apigateway:RequestValidator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RequestValidatorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RequestValidatorArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RequestValidatorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RequestValidatorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RequestValidatorArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

RequestValidator Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The RequestValidator resource accepts the following input properties:

RestApiId string: The identifier of the targeted API entity.
Name string: Name of the request validator.
ValidateRequestBody bool: Indicates whether to validate the request body according to the configured schema for the targeted API and method.
ValidateRequestParameters bool: Indicates whether to validate request parameters.

RestApiId string: The identifier of the targeted API entity.
Name string: Name of the request validator.
ValidateRequestBody bool: Indicates whether to validate the request body according to the configured schema for the targeted API and method.
ValidateRequestParameters bool: Indicates whether to validate request parameters.

restApiId String: The identifier of the targeted API entity.
name String: Name of the request validator.
validateRequestBody Boolean: Indicates whether to validate the request body according to the configured schema for the targeted API and method.
validateRequestParameters Boolean: Indicates whether to validate request parameters.

restApiId string: The identifier of the targeted API entity.
name string: Name of the request validator.
validateRequestBody boolean: Indicates whether to validate the request body according to the configured schema for the targeted API and method.
validateRequestParameters boolean: Indicates whether to validate request parameters.

rest_api_id str: The identifier of the targeted API entity.
name str: Name of the request validator.
validate_request_body bool: Indicates whether to validate the request body according to the configured schema for the targeted API and method.
validate_request_parameters bool: Indicates whether to validate request parameters.

restApiId String: The identifier of the targeted API entity.
name String: Name of the request validator.
validateRequestBody Boolean: Indicates whether to validate the request body according to the configured schema for the targeted API and method.
validateRequestParameters Boolean: Indicates whether to validate request parameters.

Outputs

All input properties are implicitly available as output properties. Additionally, the RequestValidator resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
RequestValidatorId string: ID of the request validator.

Id string: The provider-assigned unique ID for this managed resource.
RequestValidatorId string: ID of the request validator.

id String: The provider-assigned unique ID for this managed resource.
requestValidatorId String: ID of the request validator.

id string: The provider-assigned unique ID for this managed resource.
requestValidatorId string: ID of the request validator.

id str: The provider-assigned unique ID for this managed resource.
request_validator_id str: ID of the request validator.

id String: The provider-assigned unique ID for this managed resource.
requestValidatorId String: ID of the request validator.

Package Details

Repository: https://github.com/pulumi/pulumi-aws-native
License: Apache-2.0