ResponseArgs

data class ResponseArgs(val responseParameters: Output<Map<String, String>>? = null, val responseTemplates: Output<Map<String, String>>? = null, val responseType: Output<String>? = null, val restApiId: Output<String>? = null, val statusCode: Output<String>? = null) : ConvertibleToJava<ResponseArgs>

Provides an API Gateway Gateway Response for a REST API Gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const main = new aws.apigateway.RestApi("main", {name: "MyDemoAPI"});
const test = new aws.apigateway.Response("test", {
restApiId: main.id,
statusCode: "401",
responseType: "UNAUTHORIZED",
responseTemplates: {
"application/json": "{\"message\":$context.error.messageString}",
},
responseParameters: {
"gatewayresponse.header.Authorization": "'Basic'",
},
});
import pulumi
import pulumi_aws as aws
main = aws.apigateway.RestApi("main", name="MyDemoAPI")
test = aws.apigateway.Response("test",
rest_api_id=main.id,
status_code="401",
response_type="UNAUTHORIZED",
response_templates={
"application/json": "{\"message\":$context.error.messageString}",
},
response_parameters={
"gatewayresponse.header.Authorization": "'Basic'",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var main = new Aws.ApiGateway.RestApi("main", new()
{
Name = "MyDemoAPI",
});
var test = new Aws.ApiGateway.Response("test", new()
{
RestApiId = main.Id,
StatusCode = "401",
ResponseType = "UNAUTHORIZED",
ResponseTemplates =
{
{ "application/json", "{\"message\":$context.error.messageString}" },
},
ResponseParameters =
{
{ "gatewayresponse.header.Authorization", "'Basic'" },
},
});
});
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 {
main, err := apigateway.NewRestApi(ctx, "main", &apigateway.RestApiArgs{
Name: pulumi.String("MyDemoAPI"),
})
if err != nil {
return err
}
_, err = apigateway.NewResponse(ctx, "test", &apigateway.ResponseArgs{
RestApiId: main.ID(),
StatusCode: pulumi.String("401"),
ResponseType: pulumi.String("UNAUTHORIZED"),
ResponseTemplates: pulumi.StringMap{
"application/json": pulumi.String("{\"message\":$context.error.messageString}"),
},
ResponseParameters: pulumi.StringMap{
"gatewayresponse.header.Authorization": pulumi.String("'Basic'"),
},
})
if err != nil {
return err
}
return nil
})
}
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.Response;
import com.pulumi.aws.apigateway.ResponseArgs;
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 main = new RestApi("main", RestApiArgs.builder()
.name("MyDemoAPI")
.build());
var test = new Response("test", ResponseArgs.builder()
.restApiId(main.id())
.statusCode("401")
.responseType("UNAUTHORIZED")
.responseTemplates(Map.of("application/json", "{\"message\":$context.error.messageString}"))
.responseParameters(Map.of("gatewayresponse.header.Authorization", "'Basic'"))
.build());
}
}
resources:
main:
type: aws:apigateway:RestApi
properties:
name: MyDemoAPI
test:
type: aws:apigateway:Response
properties:
restApiId: ${main.id}
statusCode: '401'
responseType: UNAUTHORIZED
responseTemplates:
application/json: '{"message":$context.error.messageString}'
responseParameters:
gatewayresponse.header.Authorization: '''Basic'''

Import

Using pulumi import, import aws_api_gateway_gateway_response using REST-API-ID/RESPONSE-TYPE. For example:

$ pulumi import aws:apigateway/response:Response example 12345abcde/UNAUTHORIZED

Constructors

Link copied to clipboard
constructor(responseParameters: Output<Map<String, String>>? = null, responseTemplates: Output<Map<String, String>>? = null, responseType: Output<String>? = null, restApiId: Output<String>? = null, statusCode: Output<String>? = null)

Properties

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

Map of parameters (paths, query strings and headers) of the Gateway Response.

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

Map of templates used to transform the response body.

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

Response type of the associated GatewayResponse.

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

String identifier of the associated REST API.

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

HTTP status code of the Gateway Response.

Functions

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