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

Interface CfnRoutingRulePropsMixin.ActionInvokeApiProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRoutingRulePropsMixin.ActionInvokeApiProperty.Jsii$Proxy

Enclosing class:

CfnRoutingRulePropsMixin

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

Represents an InvokeApi action.

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.*;
 ActionInvokeApiProperty actionInvokeApiProperty = ActionInvokeApiProperty.builder()
         .apiId("apiId")
         .stage("stage")
         .stripBasePath(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRoutingRulePropsMixin.ActionInvokeApiProperty.Builder	builder()
default String	getApiId()	The API identifier of the target API.
default String	getStage()	The name of the target stage.
default Object	getStripBasePath()	The strip base path setting.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@Nullable
default String getApiId()

The API identifier of the target API.

See Also:

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

getStage

@Stability(Stable)
@Nullable
default String getStage()

The name of the target stage.

See Also:

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

getStripBasePath

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

The strip base path setting.

When true, API Gateway strips the incoming matched base path when forwarding the request to the target API.

Returns union: either Boolean or IResolvable

See Also:

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

builder

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

Returns:

a CfnRoutingRulePropsMixin.ActionInvokeApiProperty.Builder of CfnRoutingRulePropsMixin.ActionInvokeApiProperty