software.amazon.awscdk.services.apigatewayv2

Class CfnRoute

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigatewayv2.CfnRoute

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:58.248Z")
public class CfnRoute
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGatewayV2::Route`.

The AWS::ApiGatewayV2::Route resource creates a route for an API.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 Object requestModels;
 Object requestParameters;
 CfnRoute cfnRoute = CfnRoute.Builder.create(this, "MyCfnRoute")
         .apiId("apiId")
         .routeKey("routeKey")
         // the properties below are optional
         .apiKeyRequired(false)
         .authorizationScopes(List.of("authorizationScopes"))
         .authorizationType("authorizationType")
         .authorizerId("authorizerId")
         .modelSelectionExpression("modelSelectionExpression")
         .operationName("operationName")
         .requestModels(requestModels)
         .requestParameters(requestParameters)
         .routeResponseSelectionExpression("routeResponseSelectionExpression")
         .target("target")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRoute.Builder A fluent builder for CfnRoute.
static interface	CfnRoute.ParameterConstraintsProperty Specifies whether the parameter is required.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRoute(Construct scope, java.lang.String id, CfnRouteProps props) Create a new `AWS::ApiGatewayV2::Route`.
protected	CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRoute(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiId() The API identifier.
java.lang.Object	getApiKeyRequired() Specifies whether an API key is required for the route.
java.util.List<java.lang.String>	getAuthorizationScopes() The authorization scopes supported by this route.
java.lang.String	getAuthorizationType() The authorization type for the route.
java.lang.String	getAuthorizerId() The identifier of the `Authorizer` resource to be associated with this route.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getModelSelectionExpression() The model selection expression for the route.
java.lang.String	getOperationName() The operation name for the route.
java.lang.Object	getRequestModels() The request models for the route.
java.lang.Object	getRequestParameters() The request parameters for the route.
java.lang.String	getRouteKey() The route key for the route.
java.lang.String	getRouteResponseSelectionExpression() The route response selection expression for the route.
java.lang.String	getTarget() The target for the route.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApiId(java.lang.String value) The API identifier.
void	setApiKeyRequired(java.lang.Boolean value) Specifies whether an API key is required for the route.
void	setApiKeyRequired(IResolvable value) Specifies whether an API key is required for the route.
void	setAuthorizationScopes(java.util.List<java.lang.String> value) The authorization scopes supported by this route.
void	setAuthorizationType(java.lang.String value) The authorization type for the route.
void	setAuthorizerId(java.lang.String value) The identifier of the `Authorizer` resource to be associated with this route.
void	setModelSelectionExpression(java.lang.String value) The model selection expression for the route.
void	setOperationName(java.lang.String value) The operation name for the route.
void	setRequestModels(java.lang.Object value) The request models for the route.
void	setRequestParameters(java.lang.Object value) The request parameters for the route.
void	setRouteKey(java.lang.String value) The route key for the route.
void	setRouteResponseSelectionExpression(java.lang.String value) The route response selection expression for the route.
void	setTarget(java.lang.String value) The target for the route.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRoute

protected CfnRoute(software.amazon.jsii.JsiiObjectRef objRef)

CfnRoute

protected CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRoute

public CfnRoute(Construct scope,
                java.lang.String id,
                CfnRouteProps props)

Create a new `AWS::ApiGatewayV2::Route`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

public java.lang.String getApiId()

The API identifier.

setApiId

public void setApiId(java.lang.String value)

The API identifier.

getRequestModels

public java.lang.Object getRequestModels()

The request models for the route.

Supported only for WebSocket APIs.

setRequestModels

public void setRequestModels(java.lang.Object value)

The request models for the route.

Supported only for WebSocket APIs.

getRequestParameters

public java.lang.Object getRequestParameters()

The request parameters for the route.

Supported only for WebSocket APIs.

setRequestParameters

public void setRequestParameters(java.lang.Object value)

The request parameters for the route.

Supported only for WebSocket APIs.

getRouteKey

public java.lang.String getRouteKey()

The route key for the route.

For HTTP APIs, the route key can be either $default , or a combination of an HTTP method and resource path, for example, GET /pets .

setRouteKey

public void setRouteKey(java.lang.String value)

The route key for the route.

For HTTP APIs, the route key can be either $default , or a combination of an HTTP method and resource path, for example, GET /pets .

getApiKeyRequired

public java.lang.Object getApiKeyRequired()

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

setApiKeyRequired

public void setApiKeyRequired(java.lang.Boolean value)

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

setApiKeyRequired

public void setApiKeyRequired(IResolvable value)

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

getAuthorizationScopes

public java.util.List<java.lang.String> getAuthorizationScopes()

The authorization scopes supported by this route.

setAuthorizationScopes

public void setAuthorizationScopes(java.util.List<java.lang.String> value)

The authorization scopes supported by this route.

getAuthorizationType

public java.lang.String getAuthorizationType()

The authorization type for the route.

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.

setAuthorizationType

public void setAuthorizationType(java.lang.String value)

The authorization type for the route.

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.

getAuthorizerId

public java.lang.String getAuthorizerId()

The identifier of the `Authorizer` resource to be associated with this route.

The authorizer identifier is generated by API Gateway when you created the authorizer.

setAuthorizerId

public void setAuthorizerId(java.lang.String value)

The identifier of the `Authorizer` resource to be associated with this route.

The authorizer identifier is generated by API Gateway when you created the authorizer.

getModelSelectionExpression

public java.lang.String getModelSelectionExpression()

The model selection expression for the route.

Supported only for WebSocket APIs.

setModelSelectionExpression

public void setModelSelectionExpression(java.lang.String value)

The model selection expression for the route.

Supported only for WebSocket APIs.

getOperationName

public java.lang.String getOperationName()

The operation name for the route.

setOperationName

public void setOperationName(java.lang.String value)

The operation name for the route.

getRouteResponseSelectionExpression

public java.lang.String getRouteResponseSelectionExpression()

The route response selection expression for the route.

Supported only for WebSocket APIs.

setRouteResponseSelectionExpression

public void setRouteResponseSelectionExpression(java.lang.String value)

The route response selection expression for the route.

Supported only for WebSocket APIs.

getTarget

public java.lang.String getTarget()

The target for the route.

setTarget

public void setTarget(java.lang.String value)

The target for the route.