Package software.amazon.awscdk.services.apigatewayv2

Class CfnRoutingRule.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.CfnRoutingRule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRoutingRule>

Enclosing class:

CfnRoutingRule

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

A fluent builder for CfnRoutingRule.

Method Summary

Modifier and Type	Method	Description
CfnRoutingRule.Builder	actions(List<? extends Object> actions)	The resulting action based on matching a routing rules condition.
CfnRoutingRule.Builder	actions(IResolvable actions)	The resulting action based on matching a routing rules condition.
CfnRoutingRule	build()
CfnRoutingRule.Builder	conditions(List<? extends Object> conditions)	The conditions of the routing rule.
CfnRoutingRule.Builder	conditions(IResolvable conditions)	The conditions of the routing rule.
static CfnRoutingRule.Builder	create(software.constructs.Construct scope, String id)
CfnRoutingRule.Builder	domainNameArn(String domainNameArn)	The ARN of the domain name.
CfnRoutingRule.Builder	priority(Number priority)	The order in which API Gateway evaluates a rule.

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 CfnRoutingRule.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnRoutingRule.Builder.

actions

@Stability(Stable)
public CfnRoutingRule.Builder actions(IResolvable actions)

The resulting action based on matching a routing rules condition.

Only InvokeApi is supported.

Parameters:

actions - The resulting action based on matching a routing rules condition. This parameter is required.

Returns:

this

See Also:

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

actions

@Stability(Stable)
public CfnRoutingRule.Builder actions(List<? extends Object> actions)

The resulting action based on matching a routing rules condition.

Only InvokeApi is supported.

Parameters:

actions - The resulting action based on matching a routing rules condition. This parameter is required.

Returns:

this

See Also:

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

conditions

@Stability(Stable)
public CfnRoutingRule.Builder conditions(IResolvable conditions)

The conditions of the routing rule.

Parameters:

conditions - The conditions of the routing rule. This parameter is required.

Returns:

this

See Also:

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

conditions

@Stability(Stable)
public CfnRoutingRule.Builder conditions(List<? extends Object> conditions)

The conditions of the routing rule.

Parameters:

conditions - The conditions of the routing rule. This parameter is required.

Returns:

this

See Also:

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

domainNameArn

@Stability(Stable)
public CfnRoutingRule.Builder domainNameArn(String domainNameArn)

The ARN of the domain name.

Parameters:

domainNameArn - The ARN of the domain name. This parameter is required.

Returns:

this

See Also:

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

priority

@Stability(Stable)
public CfnRoutingRule.Builder priority(Number priority)

The order in which API Gateway evaluates a rule.

Priority is evaluated from the lowest value to the highest value. Rules can't have the same priority. Priority values 1-1,000,000 are supported.

Parameters:

priority - The order in which API Gateway evaluates a rule. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnRoutingRule build()

Specified by:

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

Returns:

a newly built instance of CfnRoutingRule.