1. Packages
  2. AWS Classic
  3. API Docs
  4. apigateway
  5. MethodResponse

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.apigateway.MethodResponse

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    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")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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(),
    			ParentId: myDemoAPI.RootResourceId,
    			PathPart: pulumi.String("mydemoresource"),
    		})
    		if err != nil {
    			return err
    		}
    		myDemoMethod, err := apigateway.NewMethod(ctx, "MyDemoMethod", &apigateway.MethodArgs{
    			RestApi:       myDemoAPI.ID(),
    			ResourceId:    myDemoResource.ID(),
    			HttpMethod:    pulumi.String("GET"),
    			Authorization: pulumi.String("NONE"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apigateway.NewIntegration(ctx, "MyDemoIntegration", &apigateway.IntegrationArgs{
    			RestApi:    myDemoAPI.ID(),
    			ResourceId: myDemoResource.ID(),
    			HttpMethod: myDemoMethod.HttpMethod,
    			Type:       pulumi.String("MOCK"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apigateway.NewMethodResponse(ctx, "response_200", &apigateway.MethodResponseArgs{
    			RestApi:    myDemoAPI.ID(),
    			ResourceId: myDemoResource.ID(),
    			HttpMethod: myDemoMethod.HttpMethod,
    			StatusCode: pulumi.String("200"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 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.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 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,
        })
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/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(),
    			ParentId: myDemoAPI.RootResourceId,
    			PathPart: pulumi.String("mydemoresource"),
    		})
    		if err != nil {
    			return err
    		}
    		myDemoMethod, err := apigateway.NewMethod(ctx, "MyDemoMethod", &apigateway.MethodArgs{
    			RestApi:       myDemoAPI.ID(),
    			ResourceId:    myDemoResource.ID(),
    			HttpMethod:    pulumi.String("GET"),
    			Authorization: pulumi.String("NONE"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apigateway.NewIntegration(ctx, "MyDemoIntegration", &apigateway.IntegrationArgs{
    			RestApi:    myDemoAPI.ID(),
    			ResourceId: myDemoResource.ID(),
    			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]interface{}{
    				"Message": map[string]interface{}{
    					"type": "string",
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		_, err = apigateway.NewModel(ctx, "MyDemoResponseModel", &apigateway.ModelArgs{
    			RestApi:     myDemoAPI.ID(),
    			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(),
    			ResourceId: myDemoResource.ID(),
    			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
    	})
    }
    
    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 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.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 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
    

    Create MethodResponse Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MethodResponse(name: string, args: MethodResponseArgs, opts?: CustomResourceOptions);
    @overload
    def MethodResponse(resource_name: str,
                       args: MethodResponseArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def MethodResponse(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       http_method: Optional[str] = None,
                       resource_id: Optional[str] = None,
                       rest_api: Optional[str] = None,
                       status_code: Optional[str] = None,
                       response_models: Optional[Mapping[str, str]] = None,
                       response_parameters: Optional[Mapping[str, bool]] = None)
    func NewMethodResponse(ctx *Context, name string, args MethodResponseArgs, opts ...ResourceOption) (*MethodResponse, error)
    public MethodResponse(string name, MethodResponseArgs args, CustomResourceOptions? opts = null)
    public MethodResponse(String name, MethodResponseArgs args)
    public MethodResponse(String name, MethodResponseArgs args, CustomResourceOptions options)
    
    type: aws:apigateway:MethodResponse
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args MethodResponseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MethodResponseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MethodResponseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MethodResponseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MethodResponseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var methodResponseResource = new Aws.ApiGateway.MethodResponse("methodResponseResource", new()
    {
        HttpMethod = "string",
        ResourceId = "string",
        RestApi = "string",
        StatusCode = "string",
        ResponseModels = 
        {
            { "string", "string" },
        },
        ResponseParameters = 
        {
            { "string", false },
        },
    });
    
    example, err := apigateway.NewMethodResponse(ctx, "methodResponseResource", &apigateway.MethodResponseArgs{
    	HttpMethod: pulumi.String("string"),
    	ResourceId: pulumi.String("string"),
    	RestApi:    pulumi.Any("string"),
    	StatusCode: pulumi.String("string"),
    	ResponseModels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ResponseParameters: pulumi.BoolMap{
    		"string": pulumi.Bool(false),
    	},
    })
    
    var methodResponseResource = new MethodResponse("methodResponseResource", MethodResponseArgs.builder()
        .httpMethod("string")
        .resourceId("string")
        .restApi("string")
        .statusCode("string")
        .responseModels(Map.of("string", "string"))
        .responseParameters(Map.of("string", false))
        .build());
    
    method_response_resource = aws.apigateway.MethodResponse("methodResponseResource",
        http_method="string",
        resource_id="string",
        rest_api="string",
        status_code="string",
        response_models={
            "string": "string",
        },
        response_parameters={
            "string": False,
        })
    
    const methodResponseResource = new aws.apigateway.MethodResponse("methodResponseResource", {
        httpMethod: "string",
        resourceId: "string",
        restApi: "string",
        statusCode: "string",
        responseModels: {
            string: "string",
        },
        responseParameters: {
            string: false,
        },
    });
    
    type: aws:apigateway:MethodResponse
    properties:
        httpMethod: string
        resourceId: string
        responseModels:
            string: string
        responseParameters:
            string: false
        restApi: string
        statusCode: string
    

    MethodResponse Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The MethodResponse resource accepts the following input properties:

    HttpMethod string
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    ResourceId string
    The Resource identifier for the method resource.
    RestApi string | string
    The string identifier of the associated REST API.
    StatusCode string
    The method response's status code.
    ResponseModels Dictionary<string, string>
    A 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.
    ResponseParameters Dictionary<string, bool>

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    HttpMethod string
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    ResourceId string
    The Resource identifier for the method resource.
    RestApi string | string
    The string identifier of the associated REST API.
    StatusCode string
    The method response's status code.
    ResponseModels map[string]string
    A 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.
    ResponseParameters map[string]bool

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    httpMethod String
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    resourceId String
    The Resource identifier for the method resource.
    restApi String | String
    The string identifier of the associated REST API.
    statusCode String
    The method response's status code.
    responseModels Map<String,String>
    A 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.
    responseParameters Map<String,Boolean>

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    httpMethod string
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    resourceId string
    The Resource identifier for the method resource.
    restApi string | RestApi
    The string identifier of the associated REST API.
    statusCode string
    The method response's status code.
    responseModels {[key: string]: string}
    A 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.
    responseParameters {[key: string]: boolean}

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    http_method str
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    resource_id str
    The Resource identifier for the method resource.
    rest_api str | str
    The string identifier of the associated REST API.
    status_code str
    The method response's status code.
    response_models Mapping[str, str]
    A 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.
    response_parameters Mapping[str, bool]

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    httpMethod String
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    resourceId String
    The Resource identifier for the method resource.
    restApi String |
    The string identifier of the associated REST API.
    statusCode String
    The method response's status code.
    responseModels Map<String>
    A 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.
    responseParameters Map<Boolean>

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MethodResponse resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing MethodResponse Resource

    Get an existing MethodResponse resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MethodResponseState, opts?: CustomResourceOptions): MethodResponse
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            http_method: Optional[str] = None,
            resource_id: Optional[str] = None,
            response_models: Optional[Mapping[str, str]] = None,
            response_parameters: Optional[Mapping[str, bool]] = None,
            rest_api: Optional[str] = None,
            status_code: Optional[str] = None) -> MethodResponse
    func GetMethodResponse(ctx *Context, name string, id IDInput, state *MethodResponseState, opts ...ResourceOption) (*MethodResponse, error)
    public static MethodResponse Get(string name, Input<string> id, MethodResponseState? state, CustomResourceOptions? opts = null)
    public static MethodResponse get(String name, Output<String> id, MethodResponseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    HttpMethod string
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    ResourceId string
    The Resource identifier for the method resource.
    ResponseModels Dictionary<string, string>
    A 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.
    ResponseParameters Dictionary<string, bool>

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    RestApi string | string
    The string identifier of the associated REST API.
    StatusCode string
    The method response's status code.
    HttpMethod string
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    ResourceId string
    The Resource identifier for the method resource.
    ResponseModels map[string]string
    A 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.
    ResponseParameters map[string]bool

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    RestApi string | string
    The string identifier of the associated REST API.
    StatusCode string
    The method response's status code.
    httpMethod String
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    resourceId String
    The Resource identifier for the method resource.
    responseModels Map<String,String>
    A 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.
    responseParameters Map<String,Boolean>

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    restApi String | String
    The string identifier of the associated REST API.
    statusCode String
    The method response's status code.
    httpMethod string
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    resourceId string
    The Resource identifier for the method resource.
    responseModels {[key: string]: string}
    A 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.
    responseParameters {[key: string]: boolean}

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    restApi string | RestApi
    The string identifier of the associated REST API.
    statusCode string
    The method response's status code.
    http_method str
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    resource_id str
    The Resource identifier for the method resource.
    response_models Mapping[str, str]
    A 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.
    response_parameters Mapping[str, bool]

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    rest_api str | str
    The string identifier of the associated REST API.
    status_code str
    The method response's status code.
    httpMethod String
    The HTTP verb of the method resource (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY).
    resourceId String
    The Resource identifier for the method resource.
    responseModels Map<String>
    A 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.
    responseParameters Map<Boolean>

    A 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}, where name is 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 in integration.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 of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

    restApi String |
    The string identifier of the associated REST API.
    statusCode String
    The method response's status code.

    Import

    Using pulumi import, import aws_api_gateway_method_response using REST-API-ID/RESOURCE-ID/HTTP-METHOD/STATUS-CODE. For example:

    $ pulumi import aws:apigateway/methodResponse:MethodResponse example 12345abcde/67890fghij/GET/200
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi