Interface ICallApiGatewayEndpointBaseProps
Base CallApiGatewayEdnpoint Task Props.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public interface ICallApiGatewayEndpointBaseProps : ITaskStateBaseProps
Syntax (vb)
Public Interface ICallApiGatewayEndpointBaseProps
Inherits ITaskStateBaseProps
Remarks
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.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
using Amazon.CDK;
var resultSelector;
TaskInput taskInput;
var callApiGatewayEndpointBaseProps = new CallApiGatewayEndpointBaseProps {
Method = HttpMethod.GET,
// the properties below are optional
ApiPath = "apiPath",
AuthType = AuthType.NO_AUTH,
Comment = "comment",
Headers = taskInput,
Heartbeat = Duration.Minutes(30),
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
OutputPath = "outputPath",
QueryParameters = taskInput,
RequestBody = taskInput,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
Timeout = Duration.Minutes(30)
};
Synopsis
Properties
ApiPath | Path parameters appended after API endpoint. |
AuthType | Authentication methods. |
Headers | HTTP request information that does not relate to contents of the request. |
Method | Http method for the API. |
QueryParameters | Query strings attatched to end of request. |
RequestBody | HTTP Request body. |
Properties
ApiPath
Path parameters appended after API endpoint.
virtual string ApiPath { get; }
Property Value
System.String
Remarks
Default: - No path
AuthType
Authentication methods.
virtual Nullable<AuthType> AuthType { get; }
Property Value
System.Nullable<AuthType>
Remarks
Default: AuthType.NO_AUTH
Headers
HTTP request information that does not relate to contents of the request.
virtual TaskInput Headers { get; }
Property Value
Remarks
Default: - No headers
Method
QueryParameters
Query strings attatched to end of request.
virtual TaskInput QueryParameters { get; }
Property Value
Remarks
Default: - No query parameters
RequestBody
HTTP Request body.
virtual TaskInput RequestBody { get; }
Property Value
Remarks
Default: - No request body