RouteResponse class

Manages an Amazon API Gateway Version 2 route response. More information can be found in the Amazon API Gateway Developer Guide.

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.apigatewayv2.RouteResponse("example", {
    apiId: exampleAwsApigatewayv2Api.id,
    routeId: exampleAwsApigatewayv2Route.id,
    routeResponseKey: "$default",
});
import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.RouteResponse("example",
    api_id=example_aws_apigatewayv2_api["id"],
    route_id=example_aws_apigatewayv2_route["id"],
    route_response_key="$default")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.ApiGatewayV2.RouteResponse("example", new()
    {
        ApiId = exampleAwsApigatewayv2Api.Id,
        RouteId = exampleAwsApigatewayv2Route.Id,
        RouteResponseKey = "$default",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigatewayv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigatewayv2.NewRouteResponse(ctx, "example", &apigatewayv2.RouteResponseArgs{
			ApiId:            pulumi.Any(exampleAwsApigatewayv2Api.Id),
			RouteId:          pulumi.Any(exampleAwsApigatewayv2Route.Id),
			RouteResponseKey: pulumi.String("$default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_apigatewayv2_routeresponse" "example" {
  api_id             = exampleAwsApigatewayv2Api.id
  route_id           = exampleAwsApigatewayv2Route.id
  route_response_key = "$default"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.RouteResponse;
import com.pulumi.aws.apigatewayv2.RouteResponseArgs;
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 example = new RouteResponse("example", RouteResponseArgs.builder()
            .apiId(exampleAwsApigatewayv2Api.id())
            .routeId(exampleAwsApigatewayv2Route.id())
            .routeResponseKey("$default")
            .build());

    }
}
resources:
  example:
    type: aws:apigatewayv2:RouteResponse
    properties:
      apiId: ${exampleAwsApigatewayv2Api.id}
      routeId: ${exampleAwsApigatewayv2Route.id}
      routeResponseKey: $default

> Note: For WebSocket routes requiring two-way communication, add an aws.apigatewayv2.RouteResponse to the route with routeResponseKey = "$default". Only the $default route response is supported. Use an integration response to manipulate backend responses — see Overview of integration responses.

Import

Using pulumi import, import aws.apigatewayv2.RouteResponse using the API identifier, route identifier and route response identifier. For example:

$ pulumi import aws:apigatewayv2/routeResponse:RouteResponse example aabbccddee/1122334/998877

Constructors

RouteResponse(String name, {RouteResponseArgs? args, CustomResourceOptions? options})
Creates a new RouteResponse. name The Pulumi resource name. args Arguments used to configure this RouteResponse. The set of arguments for RouteResponse. options Resource options controlling this resource's behavior.
RouteResponse.reference(String urn)
Creates a typed reference to an existing RouteResponse resource.

Properties

apiId ↔ Output<String>
API identifier.
latefinal
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
modelSelectionExpression ↔ Output<String?>
Model selection expression for the route response.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
responseModels ↔ Output<Map<String, String>?>
Response models for the route response.
latefinal
routeId ↔ Output<String>
Identifier of the aws.apigatewayv2.Route.
latefinal
routeResponseKey ↔ Output<String>
Route response key.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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

Static Methods

get(String name, Input<String> id, {RouteResponseState? state, CustomResourceOptions? options}) → RouteResponse
Gets an existing RouteResponse resource's state with the given name and id.