Class CallApiGatewayHttpApiEndpoint

Call HTTP API endpoint as a Task.

Inheritance

object

State

TaskStateBase

CallApiGatewayHttpApiEndpoint

Implements

IChainable

INextable

Inherited Members

TaskStateBase.AddCatch(IChainable, ICatchProps)

TaskStateBase.AddRetry(IRetryProps)

TaskStateBase.Metric(string, IMetricOptions)

TaskStateBase.MetricFailed(IMetricOptions)

TaskStateBase.MetricHeartbeatTimedOut(IMetricOptions)

TaskStateBase.MetricRunTime(IMetricOptions)

TaskStateBase.MetricScheduled(IMetricOptions)

TaskStateBase.MetricScheduleTime(IMetricOptions)

TaskStateBase.MetricStarted(IMetricOptions)

TaskStateBase.MetricSucceeded(IMetricOptions)

TaskStateBase.MetricTime(IMetricOptions)

TaskStateBase.MetricTimedOut(IMetricOptions)

TaskStateBase.Next(IChainable)

TaskStateBase.ToStateJson(QueryLanguage?)

TaskStateBase.WhenBoundToGraph(StateGraph)

TaskStateBase.EndStates

State.FilterNextables(State[])

State.FindReachableEndStates(State, IFindStateOptions)

State.FindReachableStates(State, IFindStateOptions)

State.PrefixStates(IConstruct, string)

State.AddBranch(StateGraph)

State.AddChoice(Condition, State, IChoiceTransitionOptions)

State.AddItemProcessor(StateGraph, IProcessorConfig)

State.AddIterator(StateGraph)

State.AddPrefix(string)

State.BindToGraph(StateGraph)

State.MakeDefault(State)

State.MakeNext(State)

State.RenderAssign(QueryLanguage?)

State.RenderBranches()

State.RenderChoices(QueryLanguage?)

State.RenderInputOutput()

State.RenderItemProcessor()

State.RenderIterator()

State.RenderNextEnd()

State.RenderQueryLanguage(QueryLanguage?)

State.RenderResultSelector()

State.RenderRetryCatch(QueryLanguage?)

State.ValidateState()

State.Branches

State.Id

State.StartState

State.StateId

State.Arguments

State.Assign

State.Comment

State.InputPath

State.OutputPath

State.Outputs

State.Parameters

State.QueryLanguage

State.ResultPath

State.ResultSelector

State.StateName

State.DefaultChoice

State.Iteration

State.Processor

State.ProcessorConfig

State.ProcessorMode

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(Construct, string, ICallApiGatewayHttpApiEndpointProps)

Call HTTP API endpoint as a Task.

Properties

ApiEndpoint	Call HTTP API endpoint as a Task.
ArnForExecuteApi	Call HTTP API endpoint as a Task.
PROPERTY_INJECTION_ID	Uniquely identifies this class.
StageName	Call HTTP API endpoint as a Task.
TaskMetrics	Call HTTP API endpoint as a Task.
TaskPolicies	Call HTTP API endpoint as a Task.

Methods

CreatePolicyStatements()	Call HTTP API endpoint as a Task.
JsonPath(Construct, string, ICallApiGatewayHttpApiEndpointJsonPathProps)	Call HTTP API endpoint as a Task using JSONPath.
Jsonata(Construct, string, ICallApiGatewayHttpApiEndpointJsonataProps)	Call HTTP API endpoint as a Task using JSONata.

Constructors

CallApiGatewayHttpApiEndpoint(Construct, string, ICallApiGatewayHttpApiEndpointProps)

Call HTTP API endpoint as a Task.

public CallApiGatewayHttpApiEndpoint(Construct scope, string id, ICallApiGatewayHttpApiEndpointProps props)

Parameters

scope Construct

id string

Descriptive identifier for this chainable.

props ICallApiGatewayHttpApiEndpointProps

Remarks

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

ExampleMetadata: infused

Properties

ApiEndpoint

Call HTTP API endpoint as a Task.

protected virtual string ApiEndpoint { get; }

Property Value

string

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
             });

ArnForExecuteApi

Call HTTP API endpoint as a Task.

protected virtual string ArnForExecuteApi { get; }

Property Value

string

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
             });

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

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

ExampleMetadata: infused

StageName

Call HTTP API endpoint as a Task.

protected virtual string? StageName { get; }

Property Value

string

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
             });

TaskMetrics

Call HTTP API endpoint as a Task.

protected override ITaskMetricsConfig? TaskMetrics { get; }

Property Value

ITaskMetricsConfig

Overrides

TaskStateBase.TaskMetrics

Remarks

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

ExampleMetadata: infused

TaskPolicies

Call HTTP API endpoint as a Task.

protected override PolicyStatement[]? TaskPolicies { get; }

Property Value

PolicyStatement[]

Overrides

TaskStateBase.TaskPolicies

Remarks

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

ExampleMetadata: infused

Methods

CreatePolicyStatements()

Call HTTP API endpoint as a Task.

protected virtual PolicyStatement[] CreatePolicyStatements()

Returns

PolicyStatement[]

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
             });

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 Construct

id string

props ICallApiGatewayHttpApiEndpointJsonPathProps

Returns

CallApiGatewayHttpApiEndpoint

Remarks

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

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 Construct

id string

props ICallApiGatewayHttpApiEndpointJsonataProps

Returns

CallApiGatewayHttpApiEndpoint

Remarks

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

Implements

IChainable

INextable