Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

AWS Classic

v4.25.0 published on Friday, Oct 15, 2021 by Pulumi

Model

Provides a Model for a REST API Gateway.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var myDemoAPI = new Aws.ApiGateway.RestApi("myDemoAPI", new Aws.ApiGateway.RestApiArgs
        {
            Description = "This is my API for demonstration purposes",
        });
        var myDemoModel = new Aws.ApiGateway.Model("myDemoModel", new Aws.ApiGateway.ModelArgs
        {
            RestApi = myDemoAPI.Id,
            Description = "a JSON schema",
            ContentType = "application/json",
            Schema = @"{
  ""type"": ""object""
}
",
        });
    }

}
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myDemoAPI, err := apigateway.NewRestApi(ctx, "myDemoAPI", &apigateway.RestApiArgs{
			Description: pulumi.String("This is my API for demonstration purposes"),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewModel(ctx, "myDemoModel", &apigateway.ModelArgs{
			RestApi:     myDemoAPI.ID(),
			Description: pulumi.String("a JSON schema"),
			ContentType: pulumi.String("application/json"),
			Schema:      pulumi.String(fmt.Sprintf("%v%v%v", "{\n", "  \"type\": \"object\"\n", "}\n")),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

my_demo_api = aws.apigateway.RestApi("myDemoAPI", description="This is my API for demonstration purposes")
my_demo_model = aws.apigateway.Model("myDemoModel",
    rest_api=my_demo_api.id,
    description="a JSON schema",
    content_type="application/json",
    schema="""{
  "type": "object"
}
""")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const myDemoAPI = new aws.apigateway.RestApi("myDemoAPI", {description: "This is my API for demonstration purposes"});
const myDemoModel = new aws.apigateway.Model("myDemoModel", {
    restApi: myDemoAPI.id,
    description: "a JSON schema",
    contentType: "application/json",
    schema: `{
  "type": "object"
}
`,
});

Create a Model Resource

new Model(name: string, args: ModelArgs, opts?: CustomResourceOptions);
@overload
def Model(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          content_type: Optional[str] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          rest_api: Optional[str] = None,
          schema: Optional[str] = None)
@overload
def Model(resource_name: str,
          args: ModelArgs,
          opts: Optional[ResourceOptions] = None)
func NewModel(ctx *Context, name string, args ModelArgs, opts ...ResourceOption) (*Model, error)
public Model(string name, ModelArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ModelArgs
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 ModelArgs
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 ModelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ModelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Model 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 Model resource accepts the following input properties:

ContentType string
The content type of the model
RestApi string | string
The ID of the associated REST API
Description string
The description of the model
Name string
The name of the model
Schema string
The schema of the model in a JSON form
ContentType string
The content type of the model
RestApi string | string
The ID of the associated REST API
Description string
The description of the model
Name string
The name of the model
Schema string
The schema of the model in a JSON form
contentType string
The content type of the model
restApi string | RestApi
The ID of the associated REST API
description string
The description of the model
name string
The name of the model
schema string
The schema of the model in a JSON form
content_type str
The content type of the model
rest_api str | str
The ID of the associated REST API
description str
The description of the model
name str
The name of the model
schema str
The schema of the model in a JSON form

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing Model Resource

Get an existing Model resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ModelState, opts?: CustomResourceOptions): Model
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        content_type: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        rest_api: Optional[str] = None,
        schema: Optional[str] = None) -> Model
func GetModel(ctx *Context, name string, id IDInput, state *ModelState, opts ...ResourceOption) (*Model, error)
public static Model Get(string name, Input<string> id, ModelState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

ContentType string
The content type of the model
Description string
The description of the model
Name string
The name of the model
RestApi string | string
The ID of the associated REST API
Schema string
The schema of the model in a JSON form
ContentType string
The content type of the model
Description string
The description of the model
Name string
The name of the model
RestApi string | string
The ID of the associated REST API
Schema string
The schema of the model in a JSON form
contentType string
The content type of the model
description string
The description of the model
name string
The name of the model
restApi string | RestApi
The ID of the associated REST API
schema string
The schema of the model in a JSON form
content_type str
The content type of the model
description str
The description of the model
name str
The name of the model
rest_api str | str
The ID of the associated REST API
schema str
The schema of the model in a JSON form

Import

aws_api_gateway_model can be imported using REST-API-ID/NAME, e.g.

 $ pulumi import aws:apigateway/model:Model example 12345abcde/example

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.