Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.apigatewayv2.RouteResponse
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API. For more information, see Set up Route Responses for a WebSocket API in API Gateway in the API Gateway Developer Guide.
Create RouteResponse Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RouteResponse(name: string, args: RouteResponseArgs, opts?: CustomResourceOptions);@overload
def RouteResponse(resource_name: str,
args: RouteResponseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RouteResponse(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
route_id: Optional[str] = None,
route_response_key: Optional[str] = None,
model_selection_expression: Optional[str] = None,
response_models: Optional[Any] = None,
response_parameters: Optional[Mapping[str, RouteResponseParameterConstraintsArgs]] = None)func NewRouteResponse(ctx *Context, name string, args RouteResponseArgs, opts ...ResourceOption) (*RouteResponse, error)public RouteResponse(string name, RouteResponseArgs args, CustomResourceOptions? opts = null)
public RouteResponse(String name, RouteResponseArgs args)
public RouteResponse(String name, RouteResponseArgs args, CustomResourceOptions options)
type: aws-native:apigatewayv2:RouteResponse
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
- args RouteResponseArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args RouteResponseArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const routeResponseResource = new aws_native.apigatewayv2.RouteResponse("routeResponseResource", {
apiId: "string",
routeId: "string",
routeResponseKey: "string",
modelSelectionExpression: "string",
responseModels: "any",
responseParameters: {
string: {
required: false,
},
},
});
Coming soon!
RouteResponse Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The RouteResponse resource accepts the following input properties:
- Api
Id string - The API identifier.
- Route
Id string - The route ID.
- Route
Response stringKey - The route response key.
- Model
Selection stringExpression - The model selection expression for the route response. Supported only for WebSocket APIs.
- Response
Models object The response models for the route response.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::RouteResponsefor more information about the expected schema for this property.- Response
Parameters Dictionary<string, Pulumi.Aws Native. Api Gateway V2. Inputs. Route Response Parameter Constraints Args> - The route response parameters.
- Api
Id string - The API identifier.
- Route
Id string - The route ID.
- Route
Response stringKey - The route response key.
- Model
Selection stringExpression - The model selection expression for the route response. Supported only for WebSocket APIs.
- Response
Models interface{} The response models for the route response.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::RouteResponsefor more information about the expected schema for this property.- Response
Parameters map[string]RouteResponse Parameter Constraints Args - The route response parameters.
- api
Id String - The API identifier.
- route
Id String - The route ID.
- route
Response StringKey - The route response key.
- model
Selection StringExpression - The model selection expression for the route response. Supported only for WebSocket APIs.
- response
Models Object The response models for the route response.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::RouteResponsefor more information about the expected schema for this property.- response
Parameters Map<String,RouteResponse Parameter Constraints Args> - The route response parameters.
- api
Id string - The API identifier.
- route
Id string - The route ID.
- route
Response stringKey - The route response key.
- model
Selection stringExpression - The model selection expression for the route response. Supported only for WebSocket APIs.
- response
Models any The response models for the route response.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::RouteResponsefor more information about the expected schema for this property.- response
Parameters {[key: string]: RouteResponse Parameter Constraints Args} - The route response parameters.
- api_
id str - The API identifier.
- route_
id str - The route ID.
- route_
response_ strkey - The route response key.
- model_
selection_ strexpression - The model selection expression for the route response. Supported only for WebSocket APIs.
- response_
models Any The response models for the route response.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::RouteResponsefor more information about the expected schema for this property.- response_
parameters Mapping[str, RouteResponse Parameter Constraints Args] - The route response parameters.
- api
Id String - The API identifier.
- route
Id String - The route ID.
- route
Response StringKey - The route response key.
- model
Selection StringExpression - The model selection expression for the route response. Supported only for WebSocket APIs.
- response
Models Any The response models for the route response.
Search the CloudFormation User Guide for
AWS::ApiGatewayV2::RouteResponsefor more information about the expected schema for this property.- response
Parameters Map<Property Map> - The route response parameters.
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.
- Route
Response stringId
- Id string
- The provider-assigned unique ID for this managed resource.
- Route
Response stringId
- id String
- The provider-assigned unique ID for this managed resource.
- route
Response StringId
- id string
- The provider-assigned unique ID for this managed resource.
- route
Response stringId
- id str
- The provider-assigned unique ID for this managed resource.
- route_
response_ strid
- id String
- The provider-assigned unique ID for this managed resource.
- route
Response StringId
Supporting Types
RouteResponseParameterConstraints, RouteResponseParameterConstraintsArgs
- Required bool
- Specifies whether the parameter is required.
- Required bool
- Specifies whether the parameter is required.
- required Boolean
- Specifies whether the parameter is required.
- required boolean
- Specifies whether the parameter is required.
- required bool
- Specifies whether the parameter is required.
- required Boolean
- Specifies whether the parameter is required.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.