Class CfnRoute
A CloudFormation AWS::ApiGatewayV2::Route
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnRoute : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRoute
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ApiGatewayV2::Route
resource creates a route for an API.
CloudformationResource: AWS::ApiGatewayV2::Route
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html
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 requestModels;
var requestParameters;
var cfnRoute = new CfnRoute(this, "MyCfnRoute", new CfnRouteProps {
ApiId = "apiId",
RouteKey = "routeKey",
// the properties below are optional
ApiKeyRequired = false,
AuthorizationScopes = new [] { "authorizationScopes" },
AuthorizationType = "authorizationType",
AuthorizerId = "authorizerId",
ModelSelectionExpression = "modelSelectionExpression",
OperationName = "operationName",
RequestModels = requestModels,
RequestParameters = requestParameters,
RouteResponseSelectionExpression = "routeResponseSelectionExpression",
Target = "target"
});
Synopsis
Constructors
CfnRoute(Construct, String, ICfnRouteProps) | Create a new |
CfnRoute(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRoute(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiId | The API identifier. |
ApiKeyRequired | Specifies whether an API key is required for the route. |
AttrRouteId | The route ID. |
AuthorizationScopes | The authorization scopes supported by this route. |
AuthorizationType | The authorization type for the route. |
AuthorizerId | The identifier of the |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ModelSelectionExpression | The model selection expression for the route. |
OperationName | The operation name for the route. |
RequestModels | The request models for the route. |
RequestParameters | The request parameters for the route. |
RouteKey | The route key for the route. |
RouteResponseSelectionExpression | The route response selection expression for the route. |
Target | The target for the route. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRoute(Construct, String, ICfnRouteProps)
Create a new AWS::ApiGatewayV2::Route
.
public CfnRoute(Construct scope, string id, ICfnRouteProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRouteProps
- resource properties.
CfnRoute(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRoute(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRoute(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRoute(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
ApiKeyRequired
Specifies whether an API key is required for the route.
public virtual object ApiKeyRequired { get; set; }
Property Value
System.Object
Remarks
Supported only for WebSocket APIs.
AttrRouteId
The route ID.
public virtual string AttrRouteId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: RouteId
AuthorizationScopes
The authorization scopes supported by this route.
public virtual string[] AuthorizationScopes { get; set; }
Property Value
System.String[]
Remarks
AuthorizationType
The authorization type for the route.
public virtual string AuthorizationType { get; set; }
Property Value
System.String
Remarks
For WebSocket APIs, valid values are NONE
for open access, AWS_IAM
for using AWS IAM permissions, and CUSTOM
for using a Lambda authorizer. For HTTP APIs, valid values are NONE
for open access, JWT
for using JSON Web Tokens, AWS_IAM
for using AWS IAM permissions, and CUSTOM
for using a Lambda authorizer.
AuthorizerId
The identifier of the Authorizer
resource to be associated with this route.
public virtual string AuthorizerId { get; set; }
Property Value
System.String
Remarks
The authorizer identifier is generated by API Gateway when you created the authorizer.
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.
public virtual string ModelSelectionExpression { get; set; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs.
OperationName
The operation name for the route.
public virtual string OperationName { get; set; }
Property Value
System.String
Remarks
RequestModels
The request models for the route.
public virtual object RequestModels { get; set; }
Property Value
System.Object
Remarks
Supported only for WebSocket APIs.
RequestParameters
The request parameters for the route.
public virtual object RequestParameters { get; set; }
Property Value
System.Object
Remarks
Supported only for WebSocket APIs.
RouteKey
The route key for the route.
public virtual string RouteKey { get; set; }
Property Value
System.String
Remarks
For HTTP APIs, the route key can be either $default
, or a combination of an HTTP method and resource path, for example, GET /pets
.
RouteResponseSelectionExpression
The route response selection expression for the route.
public virtual string RouteResponseSelectionExpression { get; set; }
Property Value
System.String
Remarks
Supported only for WebSocket APIs.
Target
The target for the route.
public virtual string Target { 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>