Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. apigatewayv2
  5. RouteResponse

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.RouteResponse

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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:

    ApiId string
    The API identifier.
    RouteId string
    The route ID.
    RouteResponseKey string
    The route response key.
    ModelSelectionExpression string
    The model selection expression for the route response. Supported only for WebSocket APIs.
    ResponseModels object

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    ResponseParameters Dictionary<string, Pulumi.AwsNative.ApiGatewayV2.Inputs.RouteResponseParameterConstraintsArgs>
    The route response parameters.
    ApiId string
    The API identifier.
    RouteId string
    The route ID.
    RouteResponseKey string
    The route response key.
    ModelSelectionExpression string
    The model selection expression for the route response. Supported only for WebSocket APIs.
    ResponseModels interface{}

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    ResponseParameters map[string]RouteResponseParameterConstraintsArgs
    The route response parameters.
    apiId String
    The API identifier.
    routeId String
    The route ID.
    routeResponseKey String
    The route response key.
    modelSelectionExpression String
    The model selection expression for the route response. Supported only for WebSocket APIs.
    responseModels Object

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    responseParameters Map<String,RouteResponseParameterConstraintsArgs>
    The route response parameters.
    apiId string
    The API identifier.
    routeId string
    The route ID.
    routeResponseKey string
    The route response key.
    modelSelectionExpression string
    The model selection expression for the route response. Supported only for WebSocket APIs.
    responseModels any

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    responseParameters {[key: string]: RouteResponseParameterConstraintsArgs}
    The route response parameters.
    api_id str
    The API identifier.
    route_id str
    The route ID.
    route_response_key str
    The route response key.
    model_selection_expression str
    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::RouteResponse for more information about the expected schema for this property.

    response_parameters Mapping[str, RouteResponseParameterConstraintsArgs]
    The route response parameters.
    apiId String
    The API identifier.
    routeId String
    The route ID.
    routeResponseKey String
    The route response key.
    modelSelectionExpression String
    The model selection expression for the route response. Supported only for WebSocket APIs.
    responseModels Any

    The response models for the route response.

    Search the CloudFormation User Guide for AWS::ApiGatewayV2::RouteResponse for more information about the expected schema for this property.

    responseParameters 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.
    RouteResponseId string
    The route response ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    RouteResponseId string
    The route response ID.
    id String
    The provider-assigned unique ID for this managed resource.
    routeResponseId String
    The route response ID.
    id string
    The provider-assigned unique ID for this managed resource.
    routeResponseId string
    The route response ID.
    id str
    The provider-assigned unique ID for this managed resource.
    route_response_id str
    The route response ID.
    id String
    The provider-assigned unique ID for this managed resource.
    routeResponseId String
    The route response ID.

    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 logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native