Model

class Model : KotlinCustomResource

Provides a Api Gateway Model resource. For information about Api Gateway Model and how to use it, see What is Model.

NOTE: Available since v1.187.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const _default = new alicloud.apigateway.Group("default", {
name: "example_value",
description: "example_value",
});
const defaultModel = new alicloud.apigateway.Model("default", {
groupId: _default.id,
modelName: "example_value",
schema: "{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}",
description: "example_value",
});
import pulumi
import pulumi_alicloud as alicloud
default = alicloud.apigateway.Group("default",
name="example_value",
description="example_value")
default_model = alicloud.apigateway.Model("default",
group_id=default.id,
model_name="example_value",
schema="{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}",
description="example_value")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var @default = new AliCloud.ApiGateway.Group("default", new()
{
Name = "example_value",
Description = "example_value",
});
var defaultModel = new AliCloud.ApiGateway.Model("default", new()
{
GroupId = @default.Id,
ModelName = "example_value",
Schema = "{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}",
Description = "example_value",
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_default, err := apigateway.NewGroup(ctx, "default", &apigateway.GroupArgs{
Name: pulumi.String("example_value"),
Description: pulumi.String("example_value"),
})
if err != nil {
return err
}
_, err = apigateway.NewModel(ctx, "default", &apigateway.ModelArgs{
GroupId: _default.ID(),
ModelName: pulumi.String("example_value"),
Schema: pulumi.String("{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}"),
Description: pulumi.String("example_value"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.Group;
import com.pulumi.alicloud.apigateway.GroupArgs;
import com.pulumi.alicloud.apigateway.Model;
import com.pulumi.alicloud.apigateway.ModelArgs;
import java.util.List;
import java.util.ArrayList;
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 default_ = new Group("default", GroupArgs.builder()
.name("example_value")
.description("example_value")
.build());
var defaultModel = new Model("defaultModel", ModelArgs.builder()
.groupId(default_.id())
.modelName("example_value")
.schema("{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}")
.description("example_value")
.build());
}
}
resources:
default:
type: alicloud:apigateway:Group
properties:
name: example_value
description: example_value
defaultModel:
type: alicloud:apigateway:Model
name: default
properties:
groupId: ${default.id}
modelName: example_value
schema: '{"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}'
description: example_value

Import

Api Gateway Model can be imported using the id, e.g.

$ pulumi import alicloud:apigateway/model:Model example <group_id>:<model_name>

Properties

Link copied to clipboard
val description: Output<String>?

The description of the model.

Link copied to clipboard
val groupId: Output<String>

The group of the model belongs to.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val modelName: Output<String>

The name of the model.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val schema: Output<String>

The schema of the model.

Link copied to clipboard
val urn: Output<String>