Modifier and Type | Method and Description |
---|---|
CfnRoute.Builder |
apiId(java.lang.String apiId)
The API identifier.
|
CfnRoute.Builder |
apiKeyRequired(java.lang.Boolean apiKeyRequired)
Specifies whether an API key is required for the route.
|
CfnRoute.Builder |
apiKeyRequired(IResolvable apiKeyRequired)
Specifies whether an API key is required for the route.
|
CfnRoute.Builder |
authorizationScopes(java.util.List<java.lang.String> authorizationScopes)
The authorization scopes supported by this route.
|
CfnRoute.Builder |
authorizationType(java.lang.String authorizationType)
The authorization type for the route.
|
CfnRoute.Builder |
authorizerId(java.lang.String authorizerId)
The identifier of the `Authorizer` resource to be associated with this route.
|
CfnRoute |
build() |
static CfnRoute.Builder |
create(Construct scope,
java.lang.String id) |
CfnRoute.Builder |
modelSelectionExpression(java.lang.String modelSelectionExpression)
The model selection expression for the route.
|
CfnRoute.Builder |
operationName(java.lang.String operationName)
The operation name for the route.
|
CfnRoute.Builder |
requestModels(java.lang.Object requestModels)
The request models for the route.
|
CfnRoute.Builder |
requestParameters(java.lang.Object requestParameters)
The request parameters for the route.
|
CfnRoute.Builder |
routeKey(java.lang.String routeKey)
The route key for the route.
|
CfnRoute.Builder |
routeResponseSelectionExpression(java.lang.String routeResponseSelectionExpression)
The route response selection expression for the route.
|
CfnRoute.Builder |
target(java.lang.String target)
The target for the route.
|
public static CfnRoute.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnRoute.ParameterConstraintsProperty.Builder
.public CfnRoute.Builder apiId(java.lang.String apiId)
apiId
- The API identifier. This parameter is required.this
public CfnRoute.Builder routeKey(java.lang.String routeKey)
For HTTP APIs, the route key can be either $default
, or a combination of an HTTP method and resource path, for example, GET /pets
.
routeKey
- The route key for the route. This parameter is required.this
public CfnRoute.Builder apiKeyRequired(java.lang.Boolean apiKeyRequired)
Supported only for WebSocket APIs.
apiKeyRequired
- Specifies whether an API key is required for the route. This parameter is required.this
public CfnRoute.Builder apiKeyRequired(IResolvable apiKeyRequired)
Supported only for WebSocket APIs.
apiKeyRequired
- Specifies whether an API key is required for the route. This parameter is required.this
public CfnRoute.Builder authorizationScopes(java.util.List<java.lang.String> authorizationScopes)
authorizationScopes
- The authorization scopes supported by this route. This parameter is required.this
public CfnRoute.Builder authorizationType(java.lang.String authorizationType)
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.
authorizationType
- The authorization type for the route. This parameter is required.this
public CfnRoute.Builder authorizerId(java.lang.String authorizerId)
The authorizer identifier is generated by API Gateway when you created the authorizer.
authorizerId
- The identifier of the `Authorizer` resource to be associated with this route. This parameter is required.this
public CfnRoute.Builder modelSelectionExpression(java.lang.String modelSelectionExpression)
Supported only for WebSocket APIs.
modelSelectionExpression
- The model selection expression for the route. This parameter is required.this
public CfnRoute.Builder operationName(java.lang.String operationName)
operationName
- The operation name for the route. This parameter is required.this
public CfnRoute.Builder requestModels(java.lang.Object requestModels)
Supported only for WebSocket APIs.
requestModels
- The request models for the route. This parameter is required.this
public CfnRoute.Builder requestParameters(java.lang.Object requestParameters)
Supported only for WebSocket APIs.
requestParameters
- The request parameters for the route. This parameter is required.this
public CfnRoute.Builder routeResponseSelectionExpression(java.lang.String routeResponseSelectionExpression)
Supported only for WebSocket APIs.
routeResponseSelectionExpression
- The route response selection expression for the route. This parameter is required.this
public CfnRoute.Builder target(java.lang.String target)
target
- The target for the route. This parameter is required.this
public CfnRoute build()