CfnRouteV2 (software.amazon.awscdk:monocdk 1.180.0.DEVPREVIEW API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - 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.apigateway.CfnRouteV2

All Implemented Interfaces:: IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Deprecated.

moved to package aws-apigatewayv2

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:41.192Z")
 @Stability(value=Deprecated)
 @Deprecated
public class CfnRouteV2
extends CfnResource
implements IInspectable

(deprecated) A CloudFormation `AWS::ApiGatewayV2::Route`.

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.apigateway.*;
 Object requestModels;
 Object requestParameters;
 CfnRouteV2 cfnRouteV2 = CfnRouteV2.Builder.create(this, "MyCfnRouteV2")
         .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();

See Also:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnRouteV2.Builder` Deprecated.
`static interface`	`CfnRouteV2.ParameterConstraintsProperty` Deprecated. moved to package aws-apigatewayv2

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

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 String CFN_RESOURCE_TYPE_NAME
Deprecated.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` Deprecated.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnRouteV2(Construct scope, String id, CfnRouteV2Props props)` Deprecated.
`protected`	`CfnRouteV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)` Deprecated.
`protected`	`CfnRouteV2(software.amazon.jsii.JsiiObjectRef objRef)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getApiId()` Deprecated.
`Object`	`getApiKeyRequired()` Deprecated.
`List<String>`	`getAuthorizationScopes()` Deprecated.
`String`	`getAuthorizationType()` Deprecated.
`String`	`getAuthorizerId()` Deprecated.
`protected Map<String,Object>`	`getCfnProperties()` Deprecated.
`String`	`getModelSelectionExpression()` Deprecated.
`String`	`getOperationName()` Deprecated.
`Object`	`getRequestModels()` Deprecated.
`Object`	`getRequestParameters()` Deprecated.
`String`	`getRouteKey()` Deprecated.
`String`	`getRouteResponseSelectionExpression()` Deprecated.
`String`	`getTarget()` Deprecated.
`void`	`inspect(TreeInspector inspector)` Deprecated.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)` Deprecated.
`void`	`setApiId(String value)` Deprecated.
`void`	`setApiKeyRequired(Boolean value)` Deprecated.
`void`	`setApiKeyRequired(IResolvable value)` Deprecated.
`void`	`setAuthorizationScopes(List<String> value)` Deprecated.
`void`	`setAuthorizationType(String value)` Deprecated.
`void`	`setAuthorizerId(String value)` Deprecated.
`void`	`setModelSelectionExpression(String value)` Deprecated.
`void`	`setOperationName(String value)` Deprecated.
`void`	`setRequestModels(Object value)` Deprecated.
`void`	`setRequestParameters(Object value)` Deprecated.
`void`	`setRouteKey(String value)` Deprecated.
`void`	`setRouteResponseSelectionExpression(String value)` Deprecated.
`void`	`setTarget(String value)` Deprecated.

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 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=Deprecated)
 @Deprecated
public static final String CFN_RESOURCE_TYPE_NAME
```
    Deprecated.
    
    (deprecated) The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnRouteV2
```
protected CfnRouteV2(software.amazon.jsii.JsiiObjectRef objRef)
```
    Deprecated.
  - CfnRouteV2
```
protected CfnRouteV2(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
    Deprecated.
  - CfnRouteV2
```
@Stability(value=Deprecated)
 @Deprecated
public CfnRouteV2(@NotNull
                                                            Construct scope,
                                                            @NotNull
                                                            String id,
                                                            @NotNull
                                                            CfnRouteV2Props props)
```
    Deprecated.
    
    (deprecated) 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=Deprecated)
 @Deprecated
public void inspect(@NotNull
                                                              TreeInspector inspector)
```
    Deprecated.
    
    (deprecated) 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=Deprecated)
 @Deprecated
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                                  Map<String,Object> props)
```
    Deprecated.
    
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
@Stability(value=Deprecated)
 @Deprecated
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Deprecated.
    
    Overrides:
    
    getCfnProperties in class CfnResource
  - getApiId
```
@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public String getApiId()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.ApiId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid
  - setApiId
```
@Stability(value=Deprecated)
 @Deprecated
public void setApiId(@NotNull
                                                               String value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.ApiId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid
  - getRequestModels
```
@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Object getRequestModels()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.RequestModels`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels
  - setRequestModels
```
@Stability(value=Deprecated)
 @Deprecated
public void setRequestModels(@NotNull
                                                                       Object value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.RequestModels`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels
  - getRequestParameters
```
@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Object getRequestParameters()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.RequestParameters`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters
  - setRequestParameters
```
@Stability(value=Deprecated)
 @Deprecated
public void setRequestParameters(@NotNull
                                                                           Object value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.RequestParameters`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters
  - getRouteKey
```
@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public String getRouteKey()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.RouteKey`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey
  - setRouteKey
```
@Stability(value=Deprecated)
 @Deprecated
public void setRouteKey(@NotNull
                                                                  String value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.RouteKey`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey
  - getApiKeyRequired
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public Object getApiKeyRequired()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.ApiKeyRequired`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired
  - setApiKeyRequired
```
@Stability(value=Deprecated)
 @Deprecated
public void setApiKeyRequired(@Nullable
                                                                        Boolean value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.ApiKeyRequired`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired
  - setApiKeyRequired
```
@Stability(value=Deprecated)
 @Deprecated
public void setApiKeyRequired(@Nullable
                                                                        IResolvable value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.ApiKeyRequired`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired
  - getAuthorizationScopes
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public List<String> getAuthorizationScopes()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.AuthorizationScopes`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes
  - setAuthorizationScopes
```
@Stability(value=Deprecated)
 @Deprecated
public void setAuthorizationScopes(@Nullable
                                                                             List<String> value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.AuthorizationScopes`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes
  - getAuthorizationType
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public String getAuthorizationType()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.AuthorizationType`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype
  - setAuthorizationType
```
@Stability(value=Deprecated)
 @Deprecated
public void setAuthorizationType(@Nullable
                                                                           String value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.AuthorizationType`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype
  - getAuthorizerId
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public String getAuthorizerId()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.AuthorizerId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid
  - setAuthorizerId
```
@Stability(value=Deprecated)
 @Deprecated
public void setAuthorizerId(@Nullable
                                                                      String value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.AuthorizerId`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid
  - getModelSelectionExpression
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public String getModelSelectionExpression()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.ModelSelectionExpression`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression
  - setModelSelectionExpression
```
@Stability(value=Deprecated)
 @Deprecated
public void setModelSelectionExpression(@Nullable
                                                                                  String value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.ModelSelectionExpression`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression
  - getOperationName
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public String getOperationName()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.OperationName`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname
  - setOperationName
```
@Stability(value=Deprecated)
 @Deprecated
public void setOperationName(@Nullable
                                                                       String value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.OperationName`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname
  - getRouteResponseSelectionExpression
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public String getRouteResponseSelectionExpression()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression
  - setRouteResponseSelectionExpression
```
@Stability(value=Deprecated)
 @Deprecated
public void setRouteResponseSelectionExpression(@Nullable
                                                                                          String value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression
  - getTarget
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public String getTarget()
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.Target`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target
  - setTarget
```
@Stability(value=Deprecated)
 @Deprecated
public void setTarget(@Nullable
                                                                String value)
```
    Deprecated.
    
    (deprecated) `AWS::ApiGatewayV2::Route.Target`.
    
    See Also:
    
    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target

Class CfnRouteV2

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnRouteV2

CfnRouteV2

CfnRouteV2

Method Detail

inspect

renderProperties

getCfnProperties

getApiId

setApiId

getRequestModels

setRequestModels

getRequestParameters

setRequestParameters

getRouteKey

setRouteKey

getApiKeyRequired

setApiKeyRequired

setApiKeyRequired

getAuthorizationScopes

setAuthorizationScopes

getAuthorizationType

setAuthorizationType

getAuthorizerId

setAuthorizerId

getModelSelectionExpression

setModelSelectionExpression

getOperationName

setOperationName

getRouteResponseSelectionExpression

setRouteResponseSelectionExpression

getTarget

setTarget