Package com.pulumi.aws.apigateway

Class Model

  • public class Model
extends com.pulumi.resources.CustomResource
    Provides a Model for a REST API Gateway. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.apigateway.RestApi;
 import com.pulumi.aws.apigateway.RestApiArgs;
 import com.pulumi.aws.apigateway.Model;
 import com.pulumi.aws.apigateway.ModelArgs;
 import static com.pulumi.codegen.internal.Serialization.*;
 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 myDemoAPI = new RestApi("myDemoAPI", RestApiArgs.builder()
             .name("MyDemoAPI")
             .description("This is my API for demonstration purposes")
             .build());
 
         var myDemoModel = new Model("myDemoModel", ModelArgs.builder()
             .restApi(myDemoAPI.id())
             .name("user")
             .description("a JSON schema")
             .contentType("application/json")
             .schema(serializeJson(
                 jsonObject(
                     jsonProperty("type", "object")
                 )))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.apigateway.Model` using `REST-API-ID/NAME`. For example: ```sh $ pulumi import aws:apigateway/model:Model example 12345abcde/example ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Model​(java.lang.String name)  
      Model​(java.lang.String name, ModelArgs args)  
      Model​(java.lang.String name, ModelArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> contentType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static Model get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ModelState 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.String>> schema()  

      • 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

      • Model

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

      • Model

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

      • Model

        public Model​(java.lang.String name,
             ModelArgs 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

      • contentType

        public com.pulumi.core.Output<java.lang.String> contentType()
        Returns:
        Content type of the model

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the model

      • name

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

      • 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

      • schema

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> schema()
        Returns:
        Schema of the model in a JSON form

      • get

        public static Model get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        ModelState 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.