ModelOptions Struct
| Source | aws-apigateway/lib/model.ts |
|---|
Example
ts
declare const api: apigateway.RestApi;
// We define the JSON Schema for the transformed valid response
const responseModel = api.addModel('ResponseModel', {
contentType: 'application/json',
modelName: 'ResponseModel',
schema: {
schema: apigateway.JsonSchemaVersion.DRAFT4,
title: 'pollResponse',
type: apigateway.JsonSchemaType.OBJECT,
properties: {
state: { type: apigateway.JsonSchemaType.STRING },
greeting: { type: apigateway.JsonSchemaType.STRING }
}
}
});
// We define the JSON Schema for the transformed error response
const errorResponseModel = api.addModel('ErrorResponseModel', {
contentType: 'application/json',
modelName: 'ErrorResponseModel',
schema: {
schema: apigateway.JsonSchemaVersion.DRAFT4,
title: 'errorResponse',
type: apigateway.JsonSchemaType.OBJECT,
properties: {
state: { type: apigateway.JsonSchemaType.STRING },
message: { type: apigateway.JsonSchemaType.STRING }
}
}
});
python
# api: apigateway.RestApi
# We define the JSON Schema for the transformed valid response
response_model = api.add_model("ResponseModel",
content_type="application/json",
model_name="ResponseModel",
schema=apigateway.JsonSchema(
schema=apigateway.JsonSchemaVersion.DRAFT4,
title="pollResponse",
type=apigateway.JsonSchemaType.OBJECT,
properties={
"state": apigateway.JsonSchema(type=apigateway.JsonSchemaType.STRING),
"greeting": apigateway.JsonSchema(type=apigateway.JsonSchemaType.STRING)
}
)
)
# We define the JSON Schema for the transformed error response
error_response_model = api.add_model("ErrorResponseModel",
content_type="application/json",
model_name="ErrorResponseModel",
schema=apigateway.JsonSchema(
schema=apigateway.JsonSchemaVersion.DRAFT4,
title="errorResponse",
type=apigateway.JsonSchemaType.OBJECT,
properties={
"state": apigateway.JsonSchema(type=apigateway.JsonSchemaType.STRING),
"message": apigateway.JsonSchema(type=apigateway.JsonSchemaType.STRING)
}
)
)
java
RestApi api;
// We define the JSON Schema for the transformed valid response
Model responseModel = api.addModel("ResponseModel", ModelOptions.builder()
.contentType("application/json")
.modelName("ResponseModel")
.schema(JsonSchema.builder()
.schema(JsonSchemaVersion.DRAFT4)
.title("pollResponse")
.type(JsonSchemaType.OBJECT)
.properties(Map.of(
"state", JsonSchema.builder().type(JsonSchemaType.STRING).build(),
"greeting", JsonSchema.builder().type(JsonSchemaType.STRING).build()))
.build())
.build());
// We define the JSON Schema for the transformed error response
Model errorResponseModel = api.addModel("ErrorResponseModel", ModelOptions.builder()
.contentType("application/json")
.modelName("ErrorResponseModel")
.schema(JsonSchema.builder()
.schema(JsonSchemaVersion.DRAFT4)
.title("errorResponse")
.type(JsonSchemaType.OBJECT)
.properties(Map.of(
"state", JsonSchema.builder().type(JsonSchemaType.STRING).build(),
"message", JsonSchema.builder().type(JsonSchemaType.STRING).build()))
.build())
.build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
RestApi api;
// We define the JSON Schema for the transformed valid response
var responseModel = api.AddModel("ResponseModel", new ModelOptions {
ContentType = "application/json",
ModelName = "ResponseModel",
Schema = new JsonSchema {
Schema = JsonSchemaVersion.DRAFT4,
Title = "pollResponse",
Type = JsonSchemaType.OBJECT,
Properties = new Dictionary<string, JsonSchema> {
{ "state", new JsonSchema { Type = JsonSchemaType.STRING } },
{ "greeting", new JsonSchema { Type = JsonSchemaType.STRING } }
}
}
});
// We define the JSON Schema for the transformed error response
var errorResponseModel = api.AddModel("ErrorResponseModel", new ModelOptions {
ContentType = "application/json",
ModelName = "ErrorResponseModel",
Schema = new JsonSchema {
Schema = JsonSchemaVersion.DRAFT4,
Title = "errorResponse",
Type = JsonSchemaType.OBJECT,
Properties = new Dictionary<string, JsonSchema> {
{ "state", new JsonSchema { Type = JsonSchemaType.STRING } },
{ "message", new JsonSchema { Type = JsonSchemaType.STRING } }
}
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var api RestApi
// We define the JSON Schema for the transformed valid response
responseModel := api.AddModel(jsii.String("ResponseModel"), &ModelOptions{
ContentType: jsii.String("application/json"),
ModelName: jsii.String("ResponseModel"),
Schema: &JsonSchema{
Schema: apigateway.JsonSchemaVersion_DRAFT4,
Title: jsii.String("pollResponse"),
Type: apigateway.JsonSchemaType_OBJECT,
Properties: map[string]JsonSchema{
"state": &JsonSchema{
"type": apigateway.JsonSchemaType_STRING,
},
"greeting": &JsonSchema{
"type": apigateway.JsonSchemaType_STRING,
},
},
},
})
// We define the JSON Schema for the transformed error response
errorResponseModel := api.AddModel(jsii.String("ErrorResponseModel"), &ModelOptions{
ContentType: jsii.String("application/json"),
ModelName: jsii.String("ErrorResponseModel"),
Schema: &JsonSchema{
Schema: apigateway.JsonSchemaVersion_DRAFT4,
Title: jsii.String("errorResponse"),
Type: apigateway.JsonSchemaType_OBJECT,
Properties: map[string]JsonSchema{
"state": &JsonSchema{
"type": apigateway.JsonSchemaType_STRING,
},
"message": &JsonSchema{
"type": apigateway.JsonSchemaType_STRING,
},
},
},
})
Properties
contentTypeoptionalstringcontent_typeoptionalstrcontentTypeoptionalStringContentTypeoptionalstringContentTypeoptional*string = 'application/json' #The content type for the model.
You can also force a content type in the request or response model mapping.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string = None #A description that identifies this model.
modelNameoptionalstringmodel_nameoptionalstrmodelNameoptionalStringModelNameoptionalstringModelNameoptional*string #A name for the model.
Default: <auto> If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type.
Important If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
The schema to use to transform data to one or more output formats.
Specify null ({}) if you don't want to specify a schema.