software.amazon.awscdk.services.apigatewayv2

Class CfnRoute

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigatewayv2.CfnRoute

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.286Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnRoute(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

@Stability(value=Stable)
 @NotNull
public String getApiId()

The API identifier.

setApiId

@Stability(value=Stable)
public void setApiId(@NotNull
                                              String value)

The API identifier.

getRequestModels

@Stability(value=Stable)
 @NotNull
public Object getRequestModels()

The request models for the route.

Supported only for WebSocket APIs.

setRequestModels

@Stability(value=Stable)
public void setRequestModels(@NotNull
                                                      Object value)

The request models for the route.

Supported only for WebSocket APIs.

getRequestParameters

@Stability(value=Stable)
 @NotNull
public Object getRequestParameters()

The request parameters for the route.

Supported only for WebSocket APIs.

setRequestParameters

@Stability(value=Stable)
public void setRequestParameters(@NotNull
                                                          Object value)

The request parameters for the route.

Supported only for WebSocket APIs.

getRouteKey

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setRouteKey(@NotNull
                                                 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

@Stability(value=Stable)
 @Nullable
public Object getApiKeyRequired()

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

setApiKeyRequired

@Stability(value=Stable)
public void setApiKeyRequired(@Nullable
                                                       Boolean value)

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

setApiKeyRequired

@Stability(value=Stable)
public void setApiKeyRequired(@Nullable
                                                       IResolvable value)

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

getAuthorizationScopes

@Stability(value=Stable)
 @Nullable
public List<String> getAuthorizationScopes()

The authorization scopes supported by this route.

setAuthorizationScopes

@Stability(value=Stable)
public void setAuthorizationScopes(@Nullable
                                                            List<String> value)

The authorization scopes supported by this route.

getAuthorizationType

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setAuthorizationType(@Nullable
                                                          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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setAuthorizerId(@Nullable
                                                     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

@Stability(value=Stable)
 @Nullable
public String getModelSelectionExpression()

The model selection expression for the route.

Supported only for WebSocket APIs.

setModelSelectionExpression

@Stability(value=Stable)
public void setModelSelectionExpression(@Nullable
                                                                 String value)

The model selection expression for the route.

Supported only for WebSocket APIs.

getOperationName

@Stability(value=Stable)
 @Nullable
public String getOperationName()

The operation name for the route.

setOperationName

@Stability(value=Stable)
public void setOperationName(@Nullable
                                                      String value)

The operation name for the route.

getRouteResponseSelectionExpression

@Stability(value=Stable)
 @Nullable
public String getRouteResponseSelectionExpression()

The route response selection expression for the route.

Supported only for WebSocket APIs.

setRouteResponseSelectionExpression

@Stability(value=Stable)
public void setRouteResponseSelectionExpression(@Nullable
                                                                         String value)

The route response selection expression for the route.

Supported only for WebSocket APIs.

getTarget

@Stability(value=Stable)
 @Nullable
public String getTarget()

The target for the route.

setTarget

@Stability(value=Stable)
public void setTarget(@Nullable
                                               String value)

The target for the route.