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

Interface CfnRoutingRulePropsMixin.ConditionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRoutingRulePropsMixin.ConditionProperty.Jsii$Proxy

Enclosing class:

CfnRoutingRulePropsMixin

@Stability(Stable)
public static interface CfnRoutingRulePropsMixin.ConditionProperty
extends software.amazon.jsii.JsiiSerializable

Represents a condition.

Conditions can contain up to two matchHeaders conditions and one matchBasePaths conditions. API Gateway evaluates header conditions and base path conditions together. You can only use AND between header and base path conditions.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.*;
 ConditionProperty conditionProperty = ConditionProperty.builder()
         .matchBasePaths(MatchBasePathsProperty.builder()
                 .anyOf(List.of("anyOf"))
                 .build())
         .matchHeaders(MatchHeadersProperty.builder()
                 .anyOf(List.of(MatchHeaderValueProperty.builder()
                         .header("header")
                         .valueGlob("valueGlob")
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRoutingRulePropsMixin.ConditionProperty.Builder	A builder for CfnRoutingRulePropsMixin.ConditionProperty
static final class	CfnRoutingRulePropsMixin.ConditionProperty.Jsii$Proxy	An implementation for CfnRoutingRulePropsMixin.ConditionProperty

Method Summary

Modifier and Type	Method	Description
static CfnRoutingRulePropsMixin.ConditionProperty.Builder	builder()
default Object	getMatchBasePaths()	The base path to be matched.
default Object	getMatchHeaders()	The headers to be matched.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMatchBasePaths

@Stability(Stable)
@Nullable
default Object getMatchBasePaths()

The base path to be matched.

Returns union: either IResolvable or CfnRoutingRulePropsMixin.MatchBasePathsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html#cfn-apigatewayv2-routingrule-condition-matchbasepaths

getMatchHeaders

@Stability(Stable)
@Nullable
default Object getMatchHeaders()

The headers to be matched.

Returns union: either IResolvable or CfnRoutingRulePropsMixin.MatchHeadersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routingrule-condition.html#cfn-apigatewayv2-routingrule-condition-matchheaders

builder

@Stability(Stable)
static CfnRoutingRulePropsMixin.ConditionProperty.Builder builder()

Returns:

a CfnRoutingRulePropsMixin.ConditionProperty.Builder of CfnRoutingRulePropsMixin.ConditionProperty