pulumi-aws-kotlin/com.pulumi.aws.apigateway.kotlin/MethodResponseArgs

MethodResponseArgs

data class MethodResponseArgs(val httpMethod: Output<String>? = null, val resourceId: Output<String>? = null, val responseModels: Output<Map<String, String>>? = null, val responseParameters: Output<Map<String, Boolean>>? = null, val restApi: Output<String>? = null, val statusCode: Output<String>? = null) : ConvertibleToJava<MethodResponseArgs>

Provides an HTTP Method Response for an API Gateway Resource.

Example Usage

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()
            .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());
    }
}
Content copied to clipboard

Import

aws_api_gateway_method_response can be imported using REST-API-ID/RESOURCE-ID/HTTP-METHOD/STATUS-CODE, e.g.,

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

Constructors

Link copied to clipboard
constructor(httpMethod: Output<String>? = null, resourceId: Output<String>? = null, responseModels: Output<Map<String, String>>? = null, responseParameters: Output<Map<String, Boolean>>? = null, restApi: Output<String>? = null, statusCode: Output<String>? = null)

Properties

Link copied to clipboard
val httpMethod: Output<String>? = null

HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY)

Link copied to clipboard
val resourceId: Output<String>? = null

API resource ID

Link copied to clipboard
val responseModels: Output<Map<String, String>>? = null

Map of the API models used for the response's content type

Link copied to clipboard
val responseParameters: Output<Map<String, Boolean>>? = null

Map of response parameters that can be sent to the caller. For example: response_parameters = { "method.response.header.X-Some-Header" = true } would define that the header X-Some-Header can be provided on the response.

Link copied to clipboard
val restApi: Output<String>? = null

ID of the associated REST API

Link copied to clipboard
val statusCode: Output<String>? = null

HTTP status code

Functions

Link copied to clipboard
open override fun toJava(): MethodResponseArgs