RouteResponse

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

Example Usage

Basic

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.ApiGatewayV2.RouteResponse("example", new Aws.ApiGatewayV2.RouteResponseArgs
        {
            ApiId = aws_apigatewayv2_api.Example.Id,
            RouteId = aws_apigatewayv2_route.Example.Id,
            RouteResponseKey = "$default",
        });
    }

}

package main

import (
    "fmt"

    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/apigatewayv2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := apigatewayv2.NewRouteResponse(ctx, "example", &apigatewayv2.RouteResponseArgs{
            ApiId:            pulumi.String(aws_apigatewayv2_api.Example.Id),
            RouteId:          pulumi.String(aws_apigatewayv2_route.Example.Id),
            RouteResponseKey: pulumi.String(fmt.Sprintf("%v%v", "$", "default")),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.RouteResponse("example",
    api_id=aws_apigatewayv2_api["example"]["id"],
    route_id=aws_apigatewayv2_route["example"]["id"],
    route_response_key="$default")

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

const example = new aws.apigatewayv2.RouteResponse("example", {
    apiId: aws_apigatewayv2_api_example.id,
    routeId: aws_apigatewayv2_route_example.id,
    routeResponseKey: "$default",
});

Create a RouteResponse Resource

new RouteResponse(name: string, args: RouteResponseArgs, opts?: CustomResourceOptions);

def RouteResponse(resource_name, opts=None, api_id=None, model_selection_expression=None, response_models=None, route_id=None, route_response_key=None, __props__=None);

func NewRouteResponse(ctx *Context, name string, args RouteResponseArgs, opts ...ResourceOption) (*RouteResponse, error)

public RouteResponse(string name, RouteResponseArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args RouteResponseArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RouteResponseArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RouteResponseArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

RouteResponse Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The RouteResponse resource accepts the following input properties:

ApiId string: The API identifier.
RouteId string: The identifier of the aws.apigatewayv2.Route.
RouteResponseKey string: The route response key.
ModelSelectionExpression string: The model selection expression for the route response.
ResponseModels Dictionary<string, string>: The response models for the route response.

ApiId string: The API identifier.
RouteId string: The identifier of the aws.apigatewayv2.Route.
RouteResponseKey string: The route response key.
ModelSelectionExpression string: The model selection expression for the route response.
ResponseModels map[string]string: The response models for the route response.

apiId string: The API identifier.
routeId string: The identifier of the aws.apigatewayv2.Route.
routeResponseKey string: The route response key.
modelSelectionExpression string: The model selection expression for the route response.
responseModels {[key: string]: string}: The response models for the route response.

api_id str: The API identifier.
route_id str: The identifier of the aws.apigatewayv2.Route.
route_response_key str: The route response key.
model_selection_expression str: The model selection expression for the route response.
response_models Dict[str, str]: The response models for the route response.

Outputs

All input properties are implicitly available as output properties. Additionally, the RouteResponse resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing RouteResponse Resource

Get an existing RouteResponse resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RouteResponseState, opts?: CustomResourceOptions): RouteResponse

static get(resource_name, id, opts=None, api_id=None, model_selection_expression=None, response_models=None, route_id=None, route_response_key=None, __props__=None);

func GetRouteResponse(ctx *Context, name string, id IDInput, state *RouteResponseState, opts ...ResourceOption) (*RouteResponse, error)

public static RouteResponse Get(string name, Input<string> id, RouteResponseState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApiId string: The API identifier.
ModelSelectionExpression string: The model selection expression for the route response.
ResponseModels Dictionary<string, string>: The response models for the route response.
RouteId string: The identifier of the aws.apigatewayv2.Route.
RouteResponseKey string: The route response key.

ApiId string: The API identifier.
ModelSelectionExpression string: The model selection expression for the route response.
ResponseModels map[string]string: The response models for the route response.
RouteId string: The identifier of the aws.apigatewayv2.Route.
RouteResponseKey string: The route response key.

apiId string: The API identifier.
modelSelectionExpression string: The model selection expression for the route response.
responseModels {[key: string]: string}: The response models for the route response.
routeId string: The identifier of the aws.apigatewayv2.Route.
routeResponseKey string: The route response key.

api_id str: The API identifier.
model_selection_expression str: The model selection expression for the route response.
response_models Dict[str, str]: The response models for the route response.
route_id str: The identifier of the aws.apigatewayv2.Route.
route_response_key str: The route response key.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud