Class CallApiGatewayRestApiEndpoint
Call REST API endpoint as a Task.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class CallApiGatewayRestApiEndpoint : TaskStateBase, IConstruct, IDependable, IChainable, INextable
Syntax (vb)
Public Class CallApiGatewayRestApiEndpoint
Inherits TaskStateBase
Implements IConstruct, IDependable, IChainable, INextable
Remarks
Be aware that the header values must be arrays. When passing the Task Token
in the headers field WAIT_FOR_TASK_TOKEN
integration, use
JsonPath.array()
to wrap the token in an array:
using Amazon.CDK.AWS.APIGateway;
RestApi api;
new CallApiGatewayRestApiEndpoint(this, "Endpoint", new CallApiGatewayRestApiEndpointProps {
Api = api,
StageName = "Stage",
Method = HttpMethod.PUT,
IntegrationPattern = IntegrationPattern.WAIT_FOR_TASK_TOKEN,
Headers = TaskInput.FromObject(new Dictionary<string, object> {
{ "TaskToken", JsonPath.Array(JsonPath.TaskToken) }
})
});
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-api-gateway.html
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.APIGateway;
RestApi api;
new CallApiGatewayRestApiEndpoint(this, "Endpoint", new CallApiGatewayRestApiEndpointProps {
Api = api,
StageName = "Stage",
Method = HttpMethod.PUT,
IntegrationPattern = IntegrationPattern.WAIT_FOR_TASK_TOKEN,
Headers = TaskInput.FromObject(new Dictionary<string, object> {
{ "TaskToken", JsonPath.Array(JsonPath.TaskToken) }
})
});
Synopsis
Constructors
CallApiGatewayRestApiEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CallApiGatewayRestApiEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CallApiGatewayRestApiEndpoint(Construct, String, ICallApiGatewayRestApiEndpointProps) |
Properties
ApiEndpoint | |
ArnForExecuteApi | |
StageName | |
TaskMetrics | |
TaskPolicies |
Methods
CreatePolicyStatements() |
Constructors
CallApiGatewayRestApiEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CallApiGatewayRestApiEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CallApiGatewayRestApiEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CallApiGatewayRestApiEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CallApiGatewayRestApiEndpoint(Construct, String, ICallApiGatewayRestApiEndpointProps)
public CallApiGatewayRestApiEndpoint(Construct scope, string id, ICallApiGatewayRestApiEndpointProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props ICallApiGatewayRestApiEndpointProps
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
Overrides
TaskPolicies
protected override PolicyStatement[] TaskPolicies { get; }
Property Value
Overrides
Methods
CreatePolicyStatements()
Implements
Constructs.IConstruct