Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. getRequestValidator

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.getRequestValidator

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGateway::RequestValidator resource sets up basic validation rules for incoming requests to your API. For more information, see Enable Basic Request Validation for an API in API Gateway in the API Gateway Developer Guide.

    Using getRequestValidator

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRequestValidator(args: GetRequestValidatorArgs, opts?: InvokeOptions): Promise<GetRequestValidatorResult>
function getRequestValidatorOutput(args: GetRequestValidatorOutputArgs, opts?: InvokeOptions): Output<GetRequestValidatorResult>
    def get_request_validator(request_validator_id: Optional[str] = None,
                          rest_api_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRequestValidatorResult
def get_request_validator_output(request_validator_id: Optional[pulumi.Input[str]] = None,
                          rest_api_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRequestValidatorResult]
    func LookupRequestValidator(ctx *Context, args *LookupRequestValidatorArgs, opts ...InvokeOption) (*LookupRequestValidatorResult, error)
func LookupRequestValidatorOutput(ctx *Context, args *LookupRequestValidatorOutputArgs, opts ...InvokeOption) LookupRequestValidatorResultOutput

    > Note: This function is named LookupRequestValidator in the Go SDK.

    public static class GetRequestValidator 
{
    public static Task<GetRequestValidatorResult> InvokeAsync(GetRequestValidatorArgs args, InvokeOptions? opts = null)
    public static Output<GetRequestValidatorResult> Invoke(GetRequestValidatorInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRequestValidatorResult> getRequestValidator(GetRequestValidatorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:apigateway:getRequestValidator
  arguments:
    # arguments dictionary

    The following arguments are supported:

    RequestValidatorId string
    The ID for the request validator. For example: abc123 .
    RestApiId string
    The string identifier of the associated RestApi.
    RequestValidatorId string
    The ID for the request validator. For example: abc123 .
    RestApiId string
    The string identifier of the associated RestApi.
    requestValidatorId String
    The ID for the request validator. For example: abc123 .
    restApiId String
    The string identifier of the associated RestApi.
    requestValidatorId string
    The ID for the request validator. For example: abc123 .
    restApiId string
    The string identifier of the associated RestApi.
    request_validator_id str
    The ID for the request validator. For example: abc123 .
    rest_api_id str
    The string identifier of the associated RestApi.
    requestValidatorId String
    The ID for the request validator. For example: abc123 .
    restApiId String
    The string identifier of the associated RestApi.

    getRequestValidator Result

    The following output properties are available:

    RequestValidatorId string
    The ID for the request validator. For example: abc123 .
    ValidateRequestBody bool
    A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    ValidateRequestParameters bool
    A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).
    RequestValidatorId string
    The ID for the request validator. For example: abc123 .
    ValidateRequestBody bool
    A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    ValidateRequestParameters bool
    A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).
    requestValidatorId String
    The ID for the request validator. For example: abc123 .
    validateRequestBody Boolean
    A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    validateRequestParameters Boolean
    A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).
    requestValidatorId string
    The ID for the request validator. For example: abc123 .
    validateRequestBody boolean
    A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    validateRequestParameters boolean
    A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).
    request_validator_id str
    The ID for the request validator. For example: abc123 .
    validate_request_body bool
    A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    validate_request_parameters bool
    A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).
    requestValidatorId String
    The ID for the request validator. For example: abc123 .
    validateRequestBody Boolean
    A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    validateRequestParameters Boolean
    A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native