Show / Hide Table of Contents

Interface CfnRoutingRulePropsMixin.IActionInvokeApiProperty

Represents an InvokeApi action.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ApiGatewayV2

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnRoutingRulePropsMixin.IActionInvokeApiProperty

Syntax (vb)

Public Interface CfnRoutingRulePropsMixin.IActionInvokeApiProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.ApiGatewayV2;

             var actionInvokeApiProperty = new ActionInvokeApiProperty {
                 ApiId = "apiId",
                 Stage = "stage",
                 StripBasePath = false
             };

Synopsis

Properties

ApiId	The API identifier of the target API.
Stage	The name of the target stage.
StripBasePath	The strip base path setting.

Properties

ApiId

The API identifier of the target API.

string? ApiId { get; }

Property Value

Remarks

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

Stage

The name of the target stage.

string? Stage { get; }

Property Value

Remarks

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

StripBasePath

The strip base path setting.

object? StripBasePath { get; }

Property Value

Remarks

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

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

Type union: either bool or IResolvable