Class CallApiGatewayHttpApiEndpoint

Call HTTP API endpoint as a Task.

Inheritance
System.Object
State
TaskStateBase
CallApiGatewayHttpApiEndpoint
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CallApiGatewayHttpApiEndpoint : TaskStateBase, IChainable, INextable
Syntax (vb)
Public Class CallApiGatewayHttpApiEndpoint
    Inherits TaskStateBase
    Implements IChainable, INextable
Remarks

See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Apigatewayv2;

var httpApi = new HttpApi(this, "MyHttpApi");

var invokeTask = new CallApiGatewayHttpApiEndpoint(this, "Call HTTP API", new CallApiGatewayHttpApiEndpointProps {
    ApiId = httpApi.ApiId,
    ApiStack = Stack.Of(httpApi),
    Method = HttpMethod.GET
});

Synopsis

Constructors

CallApiGatewayHttpApiEndpoint(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CallApiGatewayHttpApiEndpoint(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CallApiGatewayHttpApiEndpoint(Construct, String, ICallApiGatewayHttpApiEndpointProps)

Properties

ApiEndpoint
ArnForExecuteApi
StageName
TaskMetrics
TaskPolicies

Methods

CreatePolicyStatements()
Jsonata(Construct, String, ICallApiGatewayHttpApiEndpointJsonataProps)

Call HTTP API endpoint as a Task using JSONata.
JsonPath(Construct, String, ICallApiGatewayHttpApiEndpointJsonPathProps)

Call HTTP API endpoint as a Task using JSONPath.

Constructors

CallApiGatewayHttpApiEndpoint(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CallApiGatewayHttpApiEndpoint(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CallApiGatewayHttpApiEndpoint(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CallApiGatewayHttpApiEndpoint(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CallApiGatewayHttpApiEndpoint(Construct, String, ICallApiGatewayHttpApiEndpointProps)

public CallApiGatewayHttpApiEndpoint(Construct scope, string id, ICallApiGatewayHttpApiEndpointProps props)
Parameters
scope Constructs.Construct
id System.String

Descriptive identifier for this chainable.

props ICallApiGatewayHttpApiEndpointProps

Properties

ApiEndpoint

protected virtual string ApiEndpoint { get; }
Property Value

System.String

ArnForExecuteApi

protected virtual string ArnForExecuteApi { get; }
Property Value

System.String

StageName

protected virtual string StageName { get; }
Property Value

System.String

TaskMetrics

protected override ITaskMetricsConfig TaskMetrics { get; }
Property Value

ITaskMetricsConfig

Overrides

TaskPolicies

protected override PolicyStatement[] TaskPolicies { get; }
Property Value

PolicyStatement[]

Overrides

Methods

CreatePolicyStatements()

protected virtual PolicyStatement[] CreatePolicyStatements()
Returns

PolicyStatement[]

Jsonata(Construct, String, ICallApiGatewayHttpApiEndpointJsonataProps)

Call HTTP API endpoint as a Task using JSONata.

public static CallApiGatewayHttpApiEndpoint Jsonata(Construct scope, string id, ICallApiGatewayHttpApiEndpointJsonataProps props)
Parameters
scope Constructs.Construct
id System.String
props ICallApiGatewayHttpApiEndpointJsonataProps
Returns

CallApiGatewayHttpApiEndpoint

Remarks

See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html

JsonPath(Construct, String, ICallApiGatewayHttpApiEndpointJsonPathProps)

Call HTTP API endpoint as a Task using JSONPath.

public static CallApiGatewayHttpApiEndpoint JsonPath(Construct scope, string id, ICallApiGatewayHttpApiEndpointJsonPathProps props)
Parameters
scope Constructs.Construct
id System.String
props ICallApiGatewayHttpApiEndpointJsonPathProps
Returns

CallApiGatewayHttpApiEndpoint

Remarks

See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html

Implements