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

IntegrationResponseArgs

data class IntegrationResponseArgs(val contentHandling: Output<String>? = null, val httpMethod: Output<String>? = null, val resourceId: Output<String>? = null, val responseParameters: Output<Map<String, String>>? = null, val responseTemplates: Output<Map<String, String>>? = null, val restApi: Output<String>? = null, val selectionPattern: Output<String>? = null, val statusCode: Output<String>? = null) : ConvertibleToJava<IntegrationResponseArgs>

Provides an HTTP Method Integration Response for an API Gateway Resource.

Note: Depends on having aws.apigateway.Integration inside your rest api. To ensure this you might need to add an explicit depends_on for clean runs.

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 com.pulumi.aws.apigateway.IntegrationResponse;
import com.pulumi.aws.apigateway.IntegrationResponseArgs;
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());
        var myDemoIntegrationResponse = new IntegrationResponse("myDemoIntegrationResponse", IntegrationResponseArgs.builder()
            .restApi(myDemoAPI.id())
            .resourceId(myDemoResource.id())
            .httpMethod(myDemoMethod.httpMethod())
            .statusCode(response200.statusCode())
            .responseTemplates(Map.of("application/xml", """
#set($inputRoot = $input.path('$'))
<?xml version="1.0" encoding="UTF-8"?>
<message>
    $inputRoot.body
</message>
            """))
            .build());
    }
}
Content copied to clipboard

Import

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

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

Constructors

Link copied to clipboard
fun IntegrationResponseArgs(contentHandling: Output<String>? = null, httpMethod: Output<String>? = null, resourceId: Output<String>? = null, responseParameters: Output<Map<String, String>>? = null, responseTemplates: Output<Map<String, String>>? = null, restApi: Output<String>? = null, selectionPattern: Output<String>? = null, statusCode: Output<String>? = null)

Functions

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

Properties

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

How to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

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 responseParameters: Output<Map<String, String>>? = null

Map of response parameters that can be read from the backend response. For example: response_parameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }.

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

Map of templates used to transform the integration response body.

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

ID of the associated REST API.

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

Regular expression pattern used to choose an integration response based on the response from the backend. Omit configuring this to make the integration the default one. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.

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

HTTP status code. The following arguments are optional: