Package software.amazon.awscdk.services.apigatewayv2

Class CfnRouteProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.CfnRouteProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRouteProps>

Enclosing interface:

CfnRouteProps

@Stability(Stable)
public static final class CfnRouteProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRouteProps>

A builder for CfnRouteProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRouteProps.Builder	apiId(String apiId)	Sets the value of CfnRouteProps.getApiId()
CfnRouteProps.Builder	apiKeyRequired(Boolean apiKeyRequired)	Sets the value of CfnRouteProps.getApiKeyRequired()
CfnRouteProps.Builder	apiKeyRequired(IResolvable apiKeyRequired)	Sets the value of CfnRouteProps.getApiKeyRequired()
CfnRouteProps.Builder	authorizationScopes(List<String> authorizationScopes)	Sets the value of CfnRouteProps.getAuthorizationScopes()
CfnRouteProps.Builder	authorizationType(String authorizationType)	Sets the value of CfnRouteProps.getAuthorizationType()
CfnRouteProps.Builder	authorizerId(String authorizerId)	Sets the value of CfnRouteProps.getAuthorizerId()
CfnRouteProps	build()	Builds the configured instance.
CfnRouteProps.Builder	modelSelectionExpression(String modelSelectionExpression)	Sets the value of CfnRouteProps.getModelSelectionExpression()
CfnRouteProps.Builder	operationName(String operationName)	Sets the value of CfnRouteProps.getOperationName()
CfnRouteProps.Builder	requestModels(Object requestModels)	Sets the value of CfnRouteProps.getRequestModels()
CfnRouteProps.Builder	requestParameters(Object requestParameters)	Sets the value of CfnRouteProps.getRequestParameters()
CfnRouteProps.Builder	routeKey(String routeKey)	Sets the value of CfnRouteProps.getRouteKey()
CfnRouteProps.Builder	routeResponseSelectionExpression(String routeResponseSelectionExpression)	Sets the value of CfnRouteProps.getRouteResponseSelectionExpression()
CfnRouteProps.Builder	target(String target)	Sets the value of CfnRouteProps.getTarget()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

apiId

@Stability(Stable)
public CfnRouteProps.Builder apiId(String apiId)

Sets the value of CfnRouteProps.getApiId()

Parameters:

apiId - The API identifier. This parameter is required.

Returns:

this

routeKey

@Stability(Stable)
public CfnRouteProps.Builder routeKey(String routeKey)

Sets the value of CfnRouteProps.getRouteKey()

Parameters:

routeKey - The route key for the route. This parameter is required. For HTTP APIs, the route key can be either $default , or a combination of an HTTP method and resource path, for example, GET /pets .

Returns:

this

apiKeyRequired

@Stability(Stable)
public CfnRouteProps.Builder apiKeyRequired(Boolean apiKeyRequired)

Sets the value of CfnRouteProps.getApiKeyRequired()

Parameters:

apiKeyRequired - Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

Returns:

this

apiKeyRequired

@Stability(Stable)
public CfnRouteProps.Builder apiKeyRequired(IResolvable apiKeyRequired)

Sets the value of CfnRouteProps.getApiKeyRequired()

Parameters:

apiKeyRequired - Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

Returns:

this

authorizationScopes

@Stability(Stable)
public CfnRouteProps.Builder authorizationScopes(List<String> authorizationScopes)

Sets the value of CfnRouteProps.getAuthorizationScopes()

Parameters:

authorizationScopes - The authorization scopes supported by this route.

Returns:

this

authorizationType

@Stability(Stable)
public CfnRouteProps.Builder authorizationType(String authorizationType)

Sets the value of CfnRouteProps.getAuthorizationType()

Parameters:

authorizationType - 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.

Returns:

this

authorizerId

@Stability(Stable)
public CfnRouteProps.Builder authorizerId(String authorizerId)

Sets the value of CfnRouteProps.getAuthorizerId()

Parameters:

authorizerId - 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.

Returns:

this

modelSelectionExpression

@Stability(Stable)
public CfnRouteProps.Builder modelSelectionExpression(String modelSelectionExpression)

Sets the value of CfnRouteProps.getModelSelectionExpression()

Parameters:

modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.

Returns:

this

operationName

@Stability(Stable)
public CfnRouteProps.Builder operationName(String operationName)

Sets the value of CfnRouteProps.getOperationName()

Parameters:

operationName - The operation name for the route.

Returns:

this

requestModels

@Stability(Stable)
public CfnRouteProps.Builder requestModels(Object requestModels)

Sets the value of CfnRouteProps.getRequestModels()

Parameters:

requestModels - The request models for the route. Supported only for WebSocket APIs.

Returns:

this

requestParameters

@Stability(Stable)
public CfnRouteProps.Builder requestParameters(Object requestParameters)

Sets the value of CfnRouteProps.getRequestParameters()

Parameters:

requestParameters - The request parameters for the route. Supported only for WebSocket APIs.

Returns:

this

routeResponseSelectionExpression

@Stability(Stable)
public CfnRouteProps.Builder routeResponseSelectionExpression(String routeResponseSelectionExpression)

Sets the value of CfnRouteProps.getRouteResponseSelectionExpression()

Parameters:

routeResponseSelectionExpression - The route response selection expression for the route. Supported only for WebSocket APIs.

Returns:

this

target

@Stability(Stable)
public CfnRouteProps.Builder target(String target)

Sets the value of CfnRouteProps.getTarget()

Parameters:

target - The target for the route.

Returns:

this

build

@Stability(Stable)
public CfnRouteProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRouteProps>

Returns:

a new instance of CfnRouteProps

Throws:

NullPointerException - if any required attribute was not provided