MethodResponse class
Provides an HTTP Method Response for an API Gateway Resource. More information about API Gateway method responses can be found in the Amazon API Gateway Developer Guide.
Example Usage
Basic Response
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 myDemoResource = new aws.apigateway.Resource("MyDemoResource", {
restApi: myDemoAPI.id,
parentId: myDemoAPI.rootResourceId,
pathPart: "mydemoresource",
});
const myDemoMethod = new aws.apigateway.Method("MyDemoMethod", {
restApi: myDemoAPI.id,
resourceId: myDemoResource.id,
httpMethod: "GET",
authorization: "NONE",
});
const myDemoIntegration = new aws.apigateway.Integration("MyDemoIntegration", {
restApi: myDemoAPI.id,
resourceId: myDemoResource.id,
httpMethod: myDemoMethod.httpMethod,
type: "MOCK",
});
const response200 = new aws.apigateway.MethodResponse("response_200", {
restApi: myDemoAPI.id,
resourceId: myDemoResource.id,
httpMethod: myDemoMethod.httpMethod,
statusCode: "200",
});
import pulumi
import pulumi_aws as aws
my_demo_api = aws.apigateway.RestApi("MyDemoAPI",
name="MyDemoAPI",
description="This is my API for demonstration purposes")
my_demo_resource = aws.apigateway.Resource("MyDemoResource",
rest_api=my_demo_api.id,
parent_id=my_demo_api.root_resource_id,
path_part="mydemoresource")
my_demo_method = aws.apigateway.Method("MyDemoMethod",
rest_api=my_demo_api.id,
resource_id=my_demo_resource.id,
http_method="GET",
authorization="NONE")
my_demo_integration = aws.apigateway.Integration("MyDemoIntegration",
rest_api=my_demo_api.id,
resource_id=my_demo_resource.id,
http_method=my_demo_method.http_method,
type="MOCK")
response200 = aws.apigateway.MethodResponse("response_200",
rest_api=my_demo_api.id,
resource_id=my_demo_resource.id,
http_method=my_demo_method.http_method,
status_code="200")
using System.Collections.Generic;
using System.Linq;
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 myDemoResource = new Aws.ApiGateway.Resource("MyDemoResource", new()
{
RestApi = myDemoAPI.Id,
ParentId = myDemoAPI.RootResourceId,
PathPart = "mydemoresource",
});
var myDemoMethod = new Aws.ApiGateway.Method("MyDemoMethod", new()
{
RestApi = myDemoAPI.Id,
ResourceId = myDemoResource.Id,
HttpMethod = "GET",
Authorization = "NONE",
});
var myDemoIntegration = new Aws.ApiGateway.Integration("MyDemoIntegration", new()
{
RestApi = myDemoAPI.Id,
ResourceId = myDemoResource.Id,
HttpMethod = myDemoMethod.HttpMethod,
Type = "MOCK",
});
var response200 = new Aws.ApiGateway.MethodResponse("response_200", new()
{
RestApi = myDemoAPI.Id,
ResourceId = myDemoResource.Id,
HttpMethod = myDemoMethod.HttpMethod,
StatusCode = "200",
});
});
package main
import (
"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
}
myDemoResource, err := apigateway.NewResource(ctx, "MyDemoResource", &apigateway.ResourceArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ParentId: myDemoAPI.RootResourceId,
PathPart: pulumi.String("mydemoresource"),
})
if err != nil {
return err
}
myDemoMethod, err := apigateway.NewMethod(ctx, "MyDemoMethod", &apigateway.MethodArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ResourceId: myDemoResource.ID().ToIDOutput().ToStringOutput(),
HttpMethod: pulumi.String("GET"),
Authorization: pulumi.String("NONE"),
})
if err != nil {
return err
}
_, err = apigateway.NewIntegration(ctx, "MyDemoIntegration", &apigateway.IntegrationArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ResourceId: myDemoResource.ID().ToIDOutput().ToStringOutput(),
HttpMethod: myDemoMethod.HttpMethod,
Type: pulumi.String("MOCK"),
})
if err != nil {
return err
}
_, err = apigateway.NewMethodResponse(ctx, "response_200", &apigateway.MethodResponseArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ResourceId: myDemoResource.ID().ToIDOutput().ToStringOutput(),
HttpMethod: myDemoMethod.HttpMethod,
StatusCode: pulumi.String("200"),
})
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_resource" "MyDemoResource" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
parent_id = aws_apigateway_restapi.MyDemoAPI.root_resource_id
path_part = "mydemoresource"
}
resource "aws_apigateway_method" "MyDemoMethod" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
resource_id = aws_apigateway_resource.MyDemoResource.id
http_method = "GET"
authorization = "NONE"
}
resource "aws_apigateway_integration" "MyDemoIntegration" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
resource_id = aws_apigateway_resource.MyDemoResource.id
http_method = aws_apigateway_method.MyDemoMethod.http_method
type = "MOCK"
}
resource "aws_apigateway_methodresponse" "response_200" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
resource_id = aws_apigateway_resource.MyDemoResource.id
http_method = aws_apigateway_method.MyDemoMethod.http_method
status_code = "200"
}
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.Resource;
import com.pulumi.aws.apigateway.ResourceArgs;
import com.pulumi.aws.apigateway.Method;
import com.pulumi.aws.apigateway.MethodArgs;
import com.pulumi.aws.apigateway.Integration;
import com.pulumi.aws.apigateway.IntegrationArgs;
import com.pulumi.aws.apigateway.MethodResponse;
import com.pulumi.aws.apigateway.MethodResponseArgs;
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 myDemoResource = new Resource("myDemoResource", ResourceArgs.builder()
.restApi(myDemoAPI.id())
.parentId(myDemoAPI.rootResourceId())
.pathPart("mydemoresource")
.build());
var myDemoMethod = new Method("myDemoMethod", MethodArgs.builder()
.restApi(myDemoAPI.id())
.resourceId(myDemoResource.id())
.httpMethod("GET")
.authorization("NONE")
.build());
var myDemoIntegration = new Integration("myDemoIntegration", IntegrationArgs.builder()
.restApi(myDemoAPI.id())
.resourceId(myDemoResource.id())
.httpMethod(myDemoMethod.httpMethod())
.type("MOCK")
.build());
var response200 = new MethodResponse("response200", MethodResponseArgs.builder()
.restApi(myDemoAPI.id())
.resourceId(myDemoResource.id())
.httpMethod(myDemoMethod.httpMethod())
.statusCode("200")
.build());
}
}
resources:
myDemoAPI:
type: aws:apigateway:RestApi
name: MyDemoAPI
properties:
name: MyDemoAPI
description: This is my API for demonstration purposes
myDemoResource:
type: aws:apigateway:Resource
name: MyDemoResource
properties:
restApi: ${myDemoAPI.id}
parentId: ${myDemoAPI.rootResourceId}
pathPart: mydemoresource
myDemoMethod:
type: aws:apigateway:Method
name: MyDemoMethod
properties:
restApi: ${myDemoAPI.id}
resourceId: ${myDemoResource.id}
httpMethod: GET
authorization: NONE
myDemoIntegration:
type: aws:apigateway:Integration
name: MyDemoIntegration
properties:
restApi: ${myDemoAPI.id}
resourceId: ${myDemoResource.id}
httpMethod: ${myDemoMethod.httpMethod}
type: MOCK
response200:
type: aws:apigateway:MethodResponse
name: response_200
properties:
restApi: ${myDemoAPI.id}
resourceId: ${myDemoResource.id}
httpMethod: ${myDemoMethod.httpMethod}
statusCode: '200'
Response with Custom Header and Model
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 myDemoResource = new aws.apigateway.Resource("MyDemoResource", {
restApi: myDemoAPI.id,
parentId: myDemoAPI.rootResourceId,
pathPart: "mydemoresource",
});
const myDemoMethod = new aws.apigateway.Method("MyDemoMethod", {
restApi: myDemoAPI.id,
resourceId: myDemoResource.id,
httpMethod: "GET",
authorization: "NONE",
});
const myDemoIntegration = new aws.apigateway.Integration("MyDemoIntegration", {
restApi: myDemoAPI.id,
resourceId: myDemoResource.id,
httpMethod: myDemoMethod.httpMethod,
type: "MOCK",
});
const myDemoResponseModel = new aws.apigateway.Model("MyDemoResponseModel", {
restApi: myDemoAPI.id,
name: "MyDemoResponseModel",
description: "API response for MyDemoMethod",
contentType: "application/json",
schema: JSON.stringify({
$schema: "http://json-schema.org/draft-04/schema#",
title: "MyDemoResponse",
type: "object",
properties: {
Message: {
type: "string",
},
},
}),
});
const response200 = new aws.apigateway.MethodResponse("response_200", {
restApi: myDemoAPI.id,
resourceId: myDemoResource.id,
httpMethod: myDemoMethod.httpMethod,
statusCode: "200",
responseModels: {
"application/json": "MyDemoResponseModel",
},
responseParameters: {
"method.response.header.Content-Type": false,
"method-response-header.X-My-Demo-Header": false,
},
});
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_resource = aws.apigateway.Resource("MyDemoResource",
rest_api=my_demo_api.id,
parent_id=my_demo_api.root_resource_id,
path_part="mydemoresource")
my_demo_method = aws.apigateway.Method("MyDemoMethod",
rest_api=my_demo_api.id,
resource_id=my_demo_resource.id,
http_method="GET",
authorization="NONE")
my_demo_integration = aws.apigateway.Integration("MyDemoIntegration",
rest_api=my_demo_api.id,
resource_id=my_demo_resource.id,
http_method=my_demo_method.http_method,
type="MOCK")
my_demo_response_model = aws.apigateway.Model("MyDemoResponseModel",
rest_api=my_demo_api.id,
name="MyDemoResponseModel",
description="API response for MyDemoMethod",
content_type="application/json",
schema=json.dumps({
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "MyDemoResponse",
"type": "object",
"properties": {
"Message": {
"type": "string",
},
},
}))
response200 = aws.apigateway.MethodResponse("response_200",
rest_api=my_demo_api.id,
resource_id=my_demo_resource.id,
http_method=my_demo_method.http_method,
status_code="200",
response_models={
"application/json": "MyDemoResponseModel",
},
response_parameters={
"method.response.header.Content-Type": False,
"method-response-header.X-My-Demo-Header": False,
})
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 myDemoResource = new Aws.ApiGateway.Resource("MyDemoResource", new()
{
RestApi = myDemoAPI.Id,
ParentId = myDemoAPI.RootResourceId,
PathPart = "mydemoresource",
});
var myDemoMethod = new Aws.ApiGateway.Method("MyDemoMethod", new()
{
RestApi = myDemoAPI.Id,
ResourceId = myDemoResource.Id,
HttpMethod = "GET",
Authorization = "NONE",
});
var myDemoIntegration = new Aws.ApiGateway.Integration("MyDemoIntegration", new()
{
RestApi = myDemoAPI.Id,
ResourceId = myDemoResource.Id,
HttpMethod = myDemoMethod.HttpMethod,
Type = "MOCK",
});
var myDemoResponseModel = new Aws.ApiGateway.Model("MyDemoResponseModel", new()
{
RestApi = myDemoAPI.Id,
Name = "MyDemoResponseModel",
Description = "API response for MyDemoMethod",
ContentType = "application/json",
Schema = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["$schema"] = "http://json-schema.org/draft-04/schema#",
["title"] = "MyDemoResponse",
["type"] = "object",
["properties"] = new Dictionary<string, object?>
{
["Message"] = new Dictionary<string, object?>
{
["type"] = "string",
},
},
}),
});
var response200 = new Aws.ApiGateway.MethodResponse("response_200", new()
{
RestApi = myDemoAPI.Id,
ResourceId = myDemoResource.Id,
HttpMethod = myDemoMethod.HttpMethod,
StatusCode = "200",
ResponseModels =
{
{ "application/json", "MyDemoResponseModel" },
},
ResponseParameters =
{
{ "method.response.header.Content-Type", false },
{ "method-response-header.X-My-Demo-Header", false },
},
});
});
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
}
myDemoResource, err := apigateway.NewResource(ctx, "MyDemoResource", &apigateway.ResourceArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ParentId: myDemoAPI.RootResourceId,
PathPart: pulumi.String("mydemoresource"),
})
if err != nil {
return err
}
myDemoMethod, err := apigateway.NewMethod(ctx, "MyDemoMethod", &apigateway.MethodArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ResourceId: myDemoResource.ID().ToIDOutput().ToStringOutput(),
HttpMethod: pulumi.String("GET"),
Authorization: pulumi.String("NONE"),
})
if err != nil {
return err
}
_, err = apigateway.NewIntegration(ctx, "MyDemoIntegration", &apigateway.IntegrationArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ResourceId: myDemoResource.ID().ToIDOutput().ToStringOutput(),
HttpMethod: myDemoMethod.HttpMethod,
Type: pulumi.String("MOCK"),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "MyDemoResponse",
"type": "object",
"properties": map[string]map[string]string{
"Message": map[string]string{
"type": "string",
},
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = apigateway.NewModel(ctx, "MyDemoResponseModel", &apigateway.ModelArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
Name: pulumi.String("MyDemoResponseModel"),
Description: pulumi.String("API response for MyDemoMethod"),
ContentType: pulumi.String("application/json"),
Schema: pulumi.String(json0),
})
if err != nil {
return err
}
_, err = apigateway.NewMethodResponse(ctx, "response_200", &apigateway.MethodResponseArgs{
RestApi: myDemoAPI.ID().ToIDOutput().ToStringOutput(),
ResourceId: myDemoResource.ID().ToIDOutput().ToStringOutput(),
HttpMethod: myDemoMethod.HttpMethod,
StatusCode: pulumi.String("200"),
ResponseModels: pulumi.StringMap{
"application/json": pulumi.String("MyDemoResponseModel"),
},
ResponseParameters: pulumi.BoolMap{
"method.response.header.Content-Type": pulumi.Bool(false),
"method-response-header.X-My-Demo-Header": pulumi.Bool(false),
},
})
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_resource" "MyDemoResource" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
parent_id = aws_apigateway_restapi.MyDemoAPI.root_resource_id
path_part = "mydemoresource"
}
resource "aws_apigateway_method" "MyDemoMethod" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
resource_id = aws_apigateway_resource.MyDemoResource.id
http_method = "GET"
authorization = "NONE"
}
resource "aws_apigateway_integration" "MyDemoIntegration" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
resource_id = aws_apigateway_resource.MyDemoResource.id
http_method = aws_apigateway_method.MyDemoMethod.http_method
type = "MOCK"
}
resource "aws_apigateway_model" "MyDemoResponseModel" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
name = "MyDemoResponseModel"
description = "API response for MyDemoMethod"
content_type = "application/json"
schema = jsonencode({
"$schema" = "http://json-schema.org/draft-04/schema#"
"title" = "MyDemoResponse"
"type" = "object"
"properties" = {
"Message" = {
"type" = "string"
}
}
})
}
resource "aws_apigateway_methodresponse" "response_200" {
rest_api = aws_apigateway_restapi.MyDemoAPI.id
resource_id = aws_apigateway_resource.MyDemoResource.id
http_method = aws_apigateway_method.MyDemoMethod.http_method
status_code = "200"
response_models = {
"application/json" = "MyDemoResponseModel"
}
response_parameters = {
"method.response.header.Content-Type" = false
"method-response-header.X-My-Demo-Header" = false
}
}
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.Resource;
import com.pulumi.aws.apigateway.ResourceArgs;
import com.pulumi.aws.apigateway.Method;
import com.pulumi.aws.apigateway.MethodArgs;
import com.pulumi.aws.apigateway.Integration;
import com.pulumi.aws.apigateway.IntegrationArgs;
import com.pulumi.aws.apigateway.Model;
import com.pulumi.aws.apigateway.ModelArgs;
import com.pulumi.aws.apigateway.MethodResponse;
import com.pulumi.aws.apigateway.MethodResponseArgs;
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 myDemoResource = new Resource("myDemoResource", ResourceArgs.builder()
.restApi(myDemoAPI.id())
.parentId(myDemoAPI.rootResourceId())
.pathPart("mydemoresource")
.build());
var myDemoMethod = new Method("myDemoMethod", MethodArgs.builder()
.restApi(myDemoAPI.id())
.resourceId(myDemoResource.id())
.httpMethod("GET")
.authorization("NONE")
.build());
var myDemoIntegration = new Integration("myDemoIntegration", IntegrationArgs.builder()
.restApi(myDemoAPI.id())
.resourceId(myDemoResource.id())
.httpMethod(myDemoMethod.httpMethod())
.type("MOCK")
.build());
var myDemoResponseModel = new Model("myDemoResponseModel", ModelArgs.builder()
.restApi(myDemoAPI.id())
.name("MyDemoResponseModel")
.description("API response for MyDemoMethod")
.contentType("application/json")
.schema(serializeJson(
jsonObject(
jsonProperty("$schema", "http://json-schema.org/draft-04/schema#"),
jsonProperty("title", "MyDemoResponse"),
jsonProperty("type", "object"),
jsonProperty("properties", jsonObject(
jsonProperty("Message", jsonObject(
jsonProperty("type", "string")
))
))
)))
.build());
var response200 = new MethodResponse("response200", MethodResponseArgs.builder()
.restApi(myDemoAPI.id())
.resourceId(myDemoResource.id())
.httpMethod(myDemoMethod.httpMethod())
.statusCode("200")
.responseModels(Map.of("application/json", "MyDemoResponseModel"))
.responseParameters(Map.ofEntries(
Map.entry("method.response.header.Content-Type", false),
Map.entry("method-response-header.X-My-Demo-Header", false)
))
.build());
}
}
resources:
myDemoAPI:
type: aws:apigateway:RestApi
name: MyDemoAPI
properties:
name: MyDemoAPI
description: This is my API for demonstration purposes
myDemoResource:
type: aws:apigateway:Resource
name: MyDemoResource
properties:
restApi: ${myDemoAPI.id}
parentId: ${myDemoAPI.rootResourceId}
pathPart: mydemoresource
myDemoMethod:
type: aws:apigateway:Method
name: MyDemoMethod
properties:
restApi: ${myDemoAPI.id}
resourceId: ${myDemoResource.id}
httpMethod: GET
authorization: NONE
myDemoIntegration:
type: aws:apigateway:Integration
name: MyDemoIntegration
properties:
restApi: ${myDemoAPI.id}
resourceId: ${myDemoResource.id}
httpMethod: ${myDemoMethod.httpMethod}
type: MOCK
myDemoResponseModel:
type: aws:apigateway:Model
name: MyDemoResponseModel
properties:
restApi: ${myDemoAPI.id}
name: MyDemoResponseModel
description: API response for MyDemoMethod
contentType: application/json
schema:
fn::toJSON:
$schema: http://json-schema.org/draft-04/schema#
title: MyDemoResponse
type: object
properties:
Message:
type: string
response200:
type: aws:apigateway:MethodResponse
name: response_200
properties:
restApi: ${myDemoAPI.id}
resourceId: ${myDemoResource.id}
httpMethod: ${myDemoMethod.httpMethod}
statusCode: '200'
responseModels:
application/json: MyDemoResponseModel
responseParameters:
method.response.header.Content-Type: false
method-response-header.X-My-Demo-Header: false
Import
Identity Schema
Required
restApiId(String) The string identifier of the associated REST API.resourceId(String) The Resource identifier for the method resource.httpMethod(String) The HTTP verb of the method resource.statusCode(String) The method response's status code.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import aws.apigateway.MethodResponse using REST-API-ID/RESOURCE-ID/HTTP-METHOD/STATUS-CODE. For example:
$ pulumi import aws:apigateway/methodResponse:MethodResponse example 12345abcde/67890fghij/GET/200
Constructors
- MethodResponse(String name, {MethodResponseArgs? args, CustomResourceOptions? options})
-
Creates a new MethodResponse.
nameThe Pulumi resource name.argsArguments used to configure this MethodResponse. The set of arguments for MethodResponse.optionsResource options controlling this resource's behavior. - MethodResponse.reference(String urn)
- Creates a typed reference to an existing MethodResponse resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
httpMethod
↔ Output<
String> -
HTTP verb of the method resource (
GET,POST,PUT,DELETE,HEAD,OPTIONS,ANY).latefinal -
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
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceId
↔ Output<
String> -
Resource identifier for the method resource.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
responseModels
↔ Output<
Map< String, String> ?> -
Map specifying the model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
latefinal
-
responseParameters
↔ Output<
Map< String, bool> ?> -
Map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a boolean flag indicating whether the method response parameter is required. The method response header names must match the pattern of
method.response.header.{name}, wherenameis a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed inintegration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form ofintegration.response.body.{JSON-expression}, whereJSON-expressionis a valid JSON expression without the$prefix.)latefinal -
restApi
↔ Output<
String> -
String identifier of the associated REST API.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
statusCode
↔ Output<
String> -
Method response's status code.
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
Static Methods
-
get(
String name, Input< String> id, {MethodResponseState? state, CustomResourceOptions? options}) → MethodResponse -
Gets an existing MethodResponse resource's state with the given
nameandid.