Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Class CfnRoutePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.CfnRoutePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRoutePropsMixin>

Enclosing class:

CfnRoutePropsMixin

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

A fluent builder for CfnRoutePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnRoutePropsMixin.Builder	apiId(String apiId)	The API identifier.
CfnRoutePropsMixin.Builder	apiId(IApiRef apiId)	The API identifier.
CfnRoutePropsMixin.Builder	apiKeyRequired(Boolean apiKeyRequired)	Specifies whether an API key is required for the route.
CfnRoutePropsMixin.Builder	apiKeyRequired(IResolvable apiKeyRequired)	Specifies whether an API key is required for the route.
CfnRoutePropsMixin.Builder	authorizationScopes(List<String> authorizationScopes)	The authorization scopes supported by this route.
CfnRoutePropsMixin.Builder	authorizationType(String authorizationType)	The authorization type for the route.
CfnRoutePropsMixin.Builder	authorizerId(String authorizerId)	The identifier of the Authorizer resource to be associated with this route.
CfnRoutePropsMixin.Builder	authorizerId(IAuthorizerRef authorizerId)	The identifier of the Authorizer resource to be associated with this route.
CfnRoutePropsMixin	build()
static CfnRoutePropsMixin.Builder	create()
static CfnRoutePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnRoutePropsMixin.Builder	modelSelectionExpression(String modelSelectionExpression)	The model selection expression for the route.
CfnRoutePropsMixin.Builder	operationName(String operationName)	The operation name for the route.
CfnRoutePropsMixin.Builder	requestModels(Object requestModels)	The request models for the route.
CfnRoutePropsMixin.Builder	requestParameters(Object requestParameters)	The request parameters for the route.
CfnRoutePropsMixin.Builder	routeKey(String routeKey)	The route key for the route.
CfnRoutePropsMixin.Builder	routeResponseSelectionExpression(String routeResponseSelectionExpression)	The route response selection expression for the route.
CfnRoutePropsMixin.Builder	target(String target)	The target for the route.
CfnRoutePropsMixin.Builder	target(IIntegrationRef target)	The target for the route.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnRoutePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnRoutePropsMixin.Builder.

create

@Stability(Stable)
public static CfnRoutePropsMixin.Builder create()

Returns:

a new instance of CfnRoutePropsMixin.Builder.

apiId

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

The API identifier.

Parameters:

apiId - The API identifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid

apiId

@Stability(Stable)
public CfnRoutePropsMixin.Builder apiId(IApiRef apiId)

The API identifier.

Parameters:

apiId - The API identifier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid

apiKeyRequired

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

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

Parameters:

apiKeyRequired - Specifies whether an API key is required for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired

apiKeyRequired

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

Specifies whether an API key is required for the route.

Supported only for WebSocket APIs.

Parameters:

apiKeyRequired - Specifies whether an API key is required for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired

authorizationScopes

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

The authorization scopes supported by this route.

Parameters:

authorizationScopes - The authorization scopes supported by this route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes

authorizationType

@Stability(Stable)
public CfnRoutePropsMixin.Builder authorizationType(String 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.

Parameters:

authorizationType - The authorization type for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype

authorizerId

@Stability(Stable)
public CfnRoutePropsMixin.Builder authorizerId(String 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.

Parameters:

authorizerId - The identifier of the Authorizer resource to be associated with this route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid

authorizerId

@Stability(Stable)
public CfnRoutePropsMixin.Builder authorizerId(IAuthorizerRef 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.

Parameters:

authorizerId - The identifier of the Authorizer resource to be associated with this route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid

modelSelectionExpression

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

The model selection expression for the route.

Supported only for WebSocket APIs.

Parameters:

modelSelectionExpression - The model selection expression for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression

operationName

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

The operation name for the route.

Parameters:

operationName - The operation name for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname

requestModels

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

The request models for the route.

Supported only for WebSocket APIs.

Parameters:

requestModels - The request models for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels

requestParameters

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

The request parameters for the route.

Supported only for WebSocket APIs.

Parameters:

requestParameters - The request parameters for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters

routeKey

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

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 .

Parameters:

routeKey - The route key for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey

routeResponseSelectionExpression

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

The route response selection expression for the route.

Supported only for WebSocket APIs.

Parameters:

routeResponseSelectionExpression - The route response selection expression for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression

target

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

The target for the route.

Parameters:

target - The target for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target

target

@Stability(Stable)
public CfnRoutePropsMixin.Builder target(IIntegrationRef target)

The target for the route.

Parameters:

target - The target for the route. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target

build

@Stability(Stable)
public CfnRoutePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnRoutePropsMixin.