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

Class CfnRouteMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRouteMixinProps>

Enclosing interface:

CfnRouteMixinProps

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

A builder for CfnRouteMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of CfnRouteMixinProps.getApiId()

Parameters:

apiId - The API identifier.

Returns:

this

apiId

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

Sets the value of CfnRouteMixinProps.getApiId()

Parameters:

apiId - The API identifier.

Returns:

this

apiKeyRequired

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

Sets the value of CfnRouteMixinProps.getApiKeyRequired()

Parameters:

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

Returns:

this

apiKeyRequired

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

Sets the value of CfnRouteMixinProps.getApiKeyRequired()

Parameters:

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

Returns:

this

authorizationScopes

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

Sets the value of CfnRouteMixinProps.getAuthorizationScopes()

Parameters:

authorizationScopes - The authorization scopes supported by this route.

Returns:

this

authorizationType

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

Sets the value of CfnRouteMixinProps.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 CfnRouteMixinProps.Builder authorizerId(String authorizerId)

Sets the value of CfnRouteMixinProps.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

authorizerId

@Stability(Stable)
public CfnRouteMixinProps.Builder authorizerId(IAuthorizerRef authorizerId)

Sets the value of CfnRouteMixinProps.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 CfnRouteMixinProps.Builder modelSelectionExpression(String modelSelectionExpression)

Sets the value of CfnRouteMixinProps.getModelSelectionExpression()

Parameters:

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

Returns:

this

operationName

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

Sets the value of CfnRouteMixinProps.getOperationName()

Parameters:

operationName - The operation name for the route.

Returns:

this

requestModels

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

Sets the value of CfnRouteMixinProps.getRequestModels()

Parameters:

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

Returns:

this

requestParameters

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

Sets the value of CfnRouteMixinProps.getRequestParameters()

Parameters:

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

Returns:

this

routeKey

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

Sets the value of CfnRouteMixinProps.getRouteKey()

Parameters:

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 .

Returns:

this

routeResponseSelectionExpression

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

Sets the value of CfnRouteMixinProps.getRouteResponseSelectionExpression()

Parameters:

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

Returns:

this

target

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

Sets the value of CfnRouteMixinProps.getTarget()

Parameters:

target - The target for the route.

Returns:

this

target

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

Sets the value of CfnRouteMixinProps.getTarget()

Parameters:

target - The target for the route.

Returns:

this

build

@Stability(Stable)
public CfnRouteMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnRouteMixinProps

Throws:

NullPointerException - if any required attribute was not provided