Class CfnRouteResponse
A CloudFormation AWS::ApiGatewayV2::RouteResponse
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnRouteResponse : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRouteResponse
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::ApiGatewayV2::RouteResponse
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
var responseModels;
var cfnRouteResponse = new CfnRouteResponse(this, "MyCfnRouteResponse", new CfnRouteResponseProps {
ApiId = "apiId",
RouteId = "routeId",
RouteResponseKey = "routeResponseKey",
// the properties below are optional
ModelSelectionExpression = "modelSelectionExpression",
ResponseModels = responseModels,
ResponseParameters = new Dictionary<string, object> {
{ "responseParametersKey", new ParameterConstraintsProperty {
Required = false
} }
}
});
Synopsis
Constructors
CfnRouteResponse(Construct, String, ICfnRouteResponseProps) | Create a new |
CfnRouteResponse(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRouteResponse(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiId | The API identifier. |
AttrRouteResponseId | The route response ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ModelSelectionExpression | The model selection expression for the route response. |
ResponseModels | The response models for the route response. |
ResponseParameters | The route response parameters. |
RouteId | The route ID. |
RouteResponseKey | The route response key. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRouteResponse(Construct, String, ICfnRouteResponseProps)
Create a new AWS::ApiGatewayV2::RouteResponse
.
public CfnRouteResponse(Construct scope, string id, ICfnRouteResponseProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRouteResponseProps
- resource properties.
CfnRouteResponse(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRouteResponse(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRouteResponse(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRouteResponse(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiId
The API identifier.
public virtual string ApiId { get; set; }
Property Value
System.String
Remarks
AttrRouteResponseId
The route response ID.
public virtual string AttrRouteResponseId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RouteResponseId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ModelSelectionExpression
The model selection expression for the route response.
public virtual string ModelSelectionExpression { get; set; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs.
ResponseModels
The response models for the route response.
public virtual object ResponseModels { get; set; }
Property Value
System.Object
Remarks
ResponseParameters
The route response parameters.
public virtual object ResponseParameters { get; set; }
Property Value
System.Object
Remarks
RouteId
The route ID.
public virtual string RouteId { get; set; }
Property Value
System.String
Remarks
RouteResponseKey
The route response key.
public virtual string RouteResponseKey { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>