Class 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",
});
}
}
Inherited Members
Namespace: Pulumi.Aws.ApiGatewayV2
Assembly: Pulumi.Aws.dll
Syntax
public class RouteResponse : CustomResource
Constructors
View SourceRouteResponse(String, RouteResponseArgs, CustomResourceOptions)
Create a RouteResponse resource with the given unique name, arguments, and options.
Declaration
public RouteResponse(string name, RouteResponseArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| RouteResponseArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceApiId
The API identifier.
Declaration
public Output<string> ApiId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ModelSelectionExpression
The model selection expression for the route response.
Declaration
public Output<string> ModelSelectionExpression { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
ResponseModels
The response models for the route response.
Declaration
public Output<ImmutableDictionary<string, string>> ResponseModels { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>> |
RouteId
The identifier of the aws.apigatewayv2.Route.
Declaration
public Output<string> RouteId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
RouteResponseKey
The route response key.
Declaration
public Output<string> RouteResponseKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, RouteResponseState, CustomResourceOptions)
Get an existing RouteResponse resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static RouteResponse Get(string name, Input<string> id, RouteResponseState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| RouteResponseState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| RouteResponse |