Class CallApiGatewayHttpApiEndpointProps
Properties for calling an HTTP API Endpoint.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class CallApiGatewayHttpApiEndpointProps : Object, ICallApiGatewayHttpApiEndpointProps, ICallApiGatewayEndpointBaseProps, ITaskStateBaseProps
Syntax (vb)
Public Class CallApiGatewayHttpApiEndpointProps
Inherits Object
Implements ICallApiGatewayHttpApiEndpointProps, ICallApiGatewayEndpointBaseProps, ITaskStateBaseProps
Remarks
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
CallApiGatewayHttpApiEndpointProps() |
Properties
ApiId | The Id of the API to call. |
ApiPath | Path parameters appended after API endpoint. |
ApiStack | The Stack in which the API is defined. |
AuthType | Authentication methods. |
Comment | An optional description for this state. |
Headers | HTTP request information that does not relate to contents of the request. |
Heartbeat | Timeout for the heartbeat. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
IntegrationPattern | AWS Step Functions integrates with services directly in the Amazon States Language. |
Method | Http method for the API. |
OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
QueryParameters | Query strings attatched to end of request. |
RequestBody | HTTP Request body. |
ResultPath | JSONPath expression to indicate where to inject the state's output. |
ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
StageName | Name of the stage where the API is deployed to in API Gateway. |
Timeout | Timeout for the state machine. |
Constructors
CallApiGatewayHttpApiEndpointProps()
public CallApiGatewayHttpApiEndpointProps()
Properties
ApiId
The Id of the API to call.
public string ApiId { get; set; }
Property Value
System.String
ApiPath
Path parameters appended after API endpoint.
public string ApiPath { get; set; }
Property Value
System.String
Remarks
Default: - No path
ApiStack
AuthType
Authentication methods.
public Nullable<AuthType> AuthType { get; set; }
Property Value
System.Nullable<AuthType>
Remarks
Default: AuthType.NO_AUTH
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: - No comment
Headers
HTTP request information that does not relate to contents of the request.
public TaskInput Headers { get; set; }
Property Value
Remarks
Default: - No headers
Heartbeat
Timeout for the heartbeat.
public Duration Heartbeat { get; set; }
Property Value
Remarks
Default: - None
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string InputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }
Property Value
System.Nullable<IntegrationPattern>
Remarks
You can control these AWS services using service integration patterns
Default: - IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
Method
OutputPath
JSONPath expression to select select a portion of the state output to pass to the next state.
public string OutputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
QueryParameters
Query strings attatched to end of request.
public TaskInput QueryParameters { get; set; }
Property Value
Remarks
Default: - No query parameters
RequestBody
HTTP Request body.
public TaskInput RequestBody { get; set; }
Property Value
Remarks
Default: - No request body
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string ResultPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object> ResultSelector { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
StageName
Name of the stage where the API is deployed to in API Gateway.
public string StageName { get; set; }
Property Value
System.String
Remarks
Default: '$default'
Timeout
Timeout for the state machine.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: - None