interface ActionInvokeApiProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Apigatewayv2.CfnRoutingRule.ActionInvokeApiProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnRoutingRule_ActionInvokeApiProperty`
Java	`software.amazon.awscdk.services.apigatewayv2.CfnRoutingRule.ActionInvokeApiProperty`
Python	`aws_cdk.aws_apigatewayv2.CfnRoutingRule.ActionInvokeApiProperty`
TypeScript	`aws-cdk-lib` » `aws_apigatewayv2` » `CfnRoutingRule` » `ActionInvokeApiProperty`

Represents an InvokeApi action.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const actionInvokeApiProperty: apigatewayv2.CfnRoutingRule.ActionInvokeApiProperty = {
  apiId: 'apiId',
  stage: 'stage',

  // the properties below are optional
  stripBasePath: false,
};

Properties

Name	Type	Description
apiId	`string`	The API identifier of the target API.
stage	`string`	The name of the target stage.
stripBasePath?	`boolean \|` `IResolvable`	The strip base path setting.

apiId

Type: string

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

stage

Type: string

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

stripBasePath?

Type: boolean | IResolvable (optional)

The strip base path setting.

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

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

AWS CDK