Response class
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/v7/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().ToIDOutput().ToStringOutput(),
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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_restapi" "main" {
name = "MyDemoAPI"
}
resource "aws_apigateway_response" "test" {
rest_api_id = aws_apigateway_restapi.main.id
status_code = "401"
response_type = "UNAUTHORIZED"
response_templates = {
"application/json" = "{\"message\":$context.error.messageString}"
}
response_parameters = {
"gatewayresponse.header.Authorization" = "'Basic'"
}
}
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.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 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.apigateway.Response using REST-API-ID/RESPONSE-TYPE. For example:
$ pulumi import aws:apigateway/response:Response example 12345abcde/UNAUTHORIZED
Constructors
- Response(String name, {ResponseArgs? args, CustomResourceOptions? options})
-
Creates a new Response.
nameThe Pulumi resource name.argsArguments used to configure this Response. The set of arguments for Response.optionsResource options controlling this resource's behavior. - Response.reference(String urn)
- Creates a typed reference to an existing Response resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
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. See the AWS Documentation for supported values. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
responseParameters
↔ Output<
Map< String, String> ?> -
Map of parameters (paths, query strings and headers) of the Gateway Response.
latefinal
-
responseTemplates
↔ Output<
Map< String, String> ?> -
Map of templates used to transform the response body.
latefinal
-
responseType
↔ Output<
String> -
Response type of the associated GatewayResponse. See the AWS Documentation for supported values.
latefinal
-
restApiId
↔ 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?> -
HTTP status code of the Gateway Response.
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