Model class
Provides a Model for a REST API Gateway.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const myDemoAPI = new aws.apigateway.RestApi("MyDemoAPI", {
name: "MyDemoAPI",
description: "This is my API for demonstration purposes",
});
const myDemoModel = new aws.apigateway.Model("MyDemoModel", {
restApi: myDemoAPI.id,
name: "user",
description: "a JSON schema",
contentType: "application/json",
schema: JSON.stringify({
type: "object",
}),
});
import pulumi
import json
import pulumi_aws as aws
my_demo_api = aws.apigateway.RestApi("MyDemoAPI",
name="MyDemoAPI",
description="This is my API for demonstration purposes")
my_demo_model = aws.apigateway.Model("MyDemoModel",
rest_api=my_demo_api.id,
name="user",
description="a JSON schema",
content_type="application/json",
schema=json.dumps({
"type": "object",
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var myDemoAPI = new Aws.ApiGateway.RestApi("MyDemoAPI", new()
{
Name = "MyDemoAPI",
Description = "This is my API for demonstration purposes",
});
var myDemoModel = new Aws.ApiGateway.Model("MyDemoModel", new()
{
RestApi = myDemoAPI.Id,
Name = "user",
Description = "a JSON schema",
ContentType = "application/json",
Schema = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["type"] = "object",
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/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{
Name: pulumi.String("MyDemoAPI"),
Description: pulumi.String("This is my API for demonstration purposes"),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]string{
"type": "object",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = apigateway.NewModel(ctx, "MyDemoModel", &apigateway.ModelArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
Name: pulumi.String("user"),
Description: pulumi.String("a JSON schema"),
ContentType: pulumi.String("application/json"),
Schema: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_restapi" "MyDemoAPI" {
name = "MyDemoAPI"
description = "This is my API for demonstration purposes"
}
resource "aws_apigateway_model" "MyDemoModel" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
name = "user"
description = "a JSON schema"
content_type = "application/json"
schema = jsonencode({
"type" = "object"
})
}
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());
}
}
resources:
myDemoAPI:
type: aws:apigateway:RestApi
name: MyDemoAPI
properties:
name: MyDemoAPI
description: This is my API for demonstration purposes
myDemoModel:
type: aws:apigateway:Model
name: MyDemoModel
properties:
restApi: ${myDemoAPI.id}
name: user
description: a JSON schema
contentType: application/json
schema:
fn::toJSON:
type: object
Import
Using pulumi import, import aws.apigateway.Model using REST-API-ID/NAME. For example:
$ pulumi import aws:apigateway/model:Model example 12345abcde/example
Constructors
- Model(String name, {ModelArgs? args, CustomResourceOptions? options})
-
Creates a new Model.
nameThe Pulumi resource name.argsArguments used to configure this Model. The set of arguments for Model.optionsResource options controlling this resource's behavior. - Model.reference(String urn)
- Creates a typed reference to an existing Model resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
contentType
↔ Output<
String> -
Content type of the model
latefinal
-
description
↔ Output<
String?> -
Description of the model
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Name of the model
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
restApi
↔ Output<
String> -
ID of the associated REST API
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schema
↔ Output<
String?> -
Schema of the model in a JSON form
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited