Package com.pulumi.aws.apigateway

Class RequestValidator

  • public class RequestValidator
extends com.pulumi.resources.CustomResource
    Manages an API Gateway Request Validator. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.apigateway.RequestValidator` using `REST-API-ID/REQUEST-VALIDATOR-ID`. For example: ```sh $ pulumi import aws:apigateway/requestValidator:RequestValidator example 12345abcde/67890fghij ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static RequestValidator get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RequestValidatorState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> restApi()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> validateRequestBody()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> validateRequestParameters()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • RequestValidator

        public RequestValidator​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • RequestValidator

        public RequestValidator​(java.lang.String name,
                        RequestValidatorArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • RequestValidator

        public RequestValidator​(java.lang.String name,
                        RequestValidatorArgs args,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the request validator

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • restApi

        public com.pulumi.core.Output<java.lang.String> restApi()
        Returns:
        ID of the associated Rest API

      • validateRequestBody

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> validateRequestBody()
        Returns:
        Boolean whether to validate request body. Defaults to `false`.

      • validateRequestParameters

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> validateRequestParameters()
        Returns:
        Boolean whether to validate request parameters. Defaults to `false`.

      • get

        public static RequestValidator get​(java.lang.String name,
                                   com.pulumi.core.Output<java.lang.String> id,
                                   @Nullable
                                   RequestValidatorState state,
                                   @Nullable
                                   com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.