request_validators

Creates, updates, deletes, gets or lists a request_validators resource.

Overview

Name	request_validators
Type	Resource
Id	aws.apigateway.request_validators

Fields

The following fields are returned by SELECT queries:

get_request_validator

Name	Datatype	Description
id	string	The identifier of this RequestValidator.
name	string	The name of this RequestValidator
validate_request_body	boolean	A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validate_request_parameters	boolean	A Boolean flag to indicate whether to validate request parameters (true) or not (false).

get_request_validators

Name	Datatype	Description
id	string	The identifier of this RequestValidator.
name	string	The name of this RequestValidator
validate_request_body	boolean	A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
validate_request_parameters	boolean	A Boolean flag to indicate whether to validate request parameters (true) or not (false).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_request_validator	select	restapi_id, requestvalidator_id, region		Gets a RequestValidator of a given RestApi.
get_request_validators	select	restapi_id, region	position, limit	Gets the RequestValidators collection of a given RestApi.
create_request_validator	insert	restapi_id, region		Creates a RequestValidator of a given RestApi.
update_request_validator	update	restapi_id, requestvalidator_id, region		Updates a RequestValidator of a given RestApi.
delete_request_validator	delete	restapi_id, requestvalidator_id, region		Deletes a RequestValidator of a given RestApi.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
requestvalidator_id	string	The identifier of the RequestValidator to be deleted.
restapi_id	string	The string identifier of the associated RestApi.
limit	integer	The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
position	string	The current pagination position in the paged result set.

SELECT examples

get_request_validator

Gets a RequestValidator of a given RestApi.

SELECT
id,
name,
validate_request_body,
validate_request_parameters
FROM aws.apigateway.request_validators
WHERE restapi_id = '{{ restapi_id }}' -- required
AND requestvalidator_id = '{{ requestvalidator_id }}' -- required
AND region = '{{ region }}' -- required
;

get_request_validators

Gets the RequestValidators collection of a given RestApi.

SELECT
id,
name,
validate_request_body,
validate_request_parameters
FROM aws.apigateway.request_validators
WHERE restapi_id = '{{ restapi_id }}' -- required
AND region = '{{ region }}' -- required
AND position = '{{ position }}'
AND limit = '{{ limit }}'
;

INSERT examples

create_request_validator

Creates a RequestValidator of a given RestApi.

INSERT INTO aws.apigateway.request_validators (
name,
validateRequestBody,
validateRequestParameters,
restapi_id,
region
)
SELECT 
'{{ name }}',
{{ validateRequestBody }},
{{ validateRequestParameters }},
'{{ restapi_id }}',
'{{ region }}'
RETURNING
id,
name,
validate_request_body,
validate_request_parameters
;

Manifest

# Description fields are for documentation purposes
- name: request_validators
props:
  - name: restapi_id
    value: "{{ restapi_id }}"
    description: Required parameter for the request_validators resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the request_validators resource.
  - name: name
    value: "{{ name }}"
  - name: validateRequestBody
    value: {{ validateRequestBody }}
  - name: validateRequestParameters
    value: {{ validateRequestParameters }}

UPDATE examples

update_request_validator

Updates a RequestValidator of a given RestApi.

UPDATE aws.apigateway.request_validators
SET 
patchOperations = '{{ patchOperations }}'
WHERE 
restapi_id = '{{ restapi_id }}' --required
AND requestvalidator_id = '{{ requestvalidator_id }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
validate_request_body,
validate_request_parameters;

DELETE examples

delete_request_validator

Deletes a RequestValidator of a given RestApi.

DELETE FROM aws.apigateway.request_validators
WHERE restapi_id = '{{ restapi_id }}' --required
AND requestvalidator_id = '{{ requestvalidator_id }}' --required
AND region = '{{ region }}' --required
;