Model class
Manages an Amazon API Gateway Version 2 model.
Example Usage
Basic
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigatewayv2.Model("example", {
apiId: exampleAwsApigatewayv2Api.id,
contentType: "application/json",
name: "example",
schema: JSON.stringify({
$schema: "http://json-schema.org/draft-04/schema#",
title: "ExampleModel",
type: "object",
properties: {
id: {
type: "string",
},
},
}),
});
import pulumi
import json
import pulumi_aws as aws
example = aws.apigatewayv2.Model("example",
api_id=example_aws_apigatewayv2_api["id"],
content_type="application/json",
name="example",
schema=json.dumps({
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ExampleModel",
"type": "object",
"properties": {
"id": {
"type": "string",
},
},
}))
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGatewayV2.Model("example", new()
{
ApiId = exampleAwsApigatewayv2Api.Id,
ContentType = "application/json",
Name = "example",
Schema = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["$schema"] = "http://json-schema.org/draft-04/schema#",
["title"] = "ExampleModel",
["type"] = "object",
["properties"] = new Dictionary<string, object?>
{
["id"] = new Dictionary<string, object?>
{
["type"] = "string",
},
},
}),
});
});
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigatewayv2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ExampleModel",
"type": "object",
"properties": map[string]map[string]string{
"id": map[string]string{
"type": "string",
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = apigatewayv2.NewModel(ctx, "example", &apigatewayv2.ModelArgs{
ApiId: pulumi.Any(exampleAwsApigatewayv2Api.Id),
ContentType: pulumi.String("application/json"),
Name: pulumi.String("example"),
Schema: pulumi.String(json0),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigatewayv2_model" "example" {
api_id = exampleAwsApigatewayv2Api.id
content_type = "application/json"
name = "example"
schema = jsonencode({
"$schema" = "http://json-schema.org/draft-04/schema#"
"title" = "ExampleModel"
"type" = "object"
"properties" = {
"id" = {
"type" = "string"
}
}
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Model;
import com.pulumi.aws.apigatewayv2.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 example = new Model("example", ModelArgs.builder()
.apiId(exampleAwsApigatewayv2Api.id())
.contentType("application/json")
.name("example")
.schema(serializeJson(
jsonObject(
jsonProperty("$schema", "http://json-schema.org/draft-04/schema#"),
jsonProperty("title", "ExampleModel"),
jsonProperty("type", "object"),
jsonProperty("properties", jsonObject(
jsonProperty("id", jsonObject(
jsonProperty("type", "string")
))
))
)))
.build());
}
}
resources:
example:
type: aws:apigatewayv2:Model
properties:
apiId: ${exampleAwsApigatewayv2Api.id}
contentType: application/json
name: example
schema:
fn::toJSON:
$schema: http://json-schema.org/draft-04/schema#
title: ExampleModel
type: object
properties:
id:
type: string
Import
Using pulumi import, import aws.apigatewayv2.Model using the API identifier and model identifier. For example:
$ pulumi import aws:apigatewayv2/model:Model example aabbccddee/1122334
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
-
apiId
↔ Output<
String> -
API identifier.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
contentType
↔ Output<
String> -
Content-type for the model, for example,
application/json. Must be between 1 and 256 characters in length.latefinal -
description
↔ Output<
String?> -
Description of the model. Must be between 1 and 128 characters in length.
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. Must be alphanumeric. Must be between 1 and 128 characters in length.
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
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schema
↔ Output<
String> -
Schema for the model. This should be a JSON schema draft 4 model. Must be less than or equal to 32768 characters in length.
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