Package software.amazon.awscdk.services.stepfunctions.tasks

Interface CallApiGatewayEndpointBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Subinterfaces:

CallApiGatewayHttpApiEndpointProps, CallApiGatewayRestApiEndpointProps

All Known Implementing Classes:

CallApiGatewayEndpointBaseProps.Jsii$Proxy, CallApiGatewayHttpApiEndpointProps.Jsii$Proxy, CallApiGatewayRestApiEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:25.381Z")
@Stability(Stable)
public interface CallApiGatewayEndpointBaseProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Base CallApiGatewayEdnpoint Task Props.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 Object resultSelector;
 TaskInput taskInput;
 TaskRole taskRole;
 Timeout timeout;
 CallApiGatewayEndpointBaseProps callApiGatewayEndpointBaseProps = CallApiGatewayEndpointBaseProps.builder()
         .method(HttpMethod.GET)
         // the properties below are optional
         .apiPath("apiPath")
         .authType(AuthType.NO_AUTH)
         .comment("comment")
         .credentials(Credentials.builder()
                 .role(taskRole)
                 .build())
         .headers(taskInput)
         .heartbeat(Duration.minutes(30))
         .heartbeatTimeout(timeout)
         .inputPath("inputPath")
         .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
         .outputPath("outputPath")
         .queryParameters(taskInput)
         .requestBody(taskInput)
         .resultPath("resultPath")
         .resultSelector(Map.of(
                 "resultSelectorKey", resultSelector))
         .stateName("stateName")
         .taskTimeout(timeout)
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CallApiGatewayEndpointBaseProps.Builder	A builder for CallApiGatewayEndpointBaseProps
static final class	CallApiGatewayEndpointBaseProps.Jsii$Proxy	An implementation for CallApiGatewayEndpointBaseProps

Method Summary

Modifier and Type	Method	Description
static CallApiGatewayEndpointBaseProps.Builder	builder()
default String	getApiPath()	Path parameters appended after API endpoint.
default AuthType	getAuthType()	Authentication methods.
default TaskInput	getHeaders()	HTTP request information that does not relate to contents of the request.
HttpMethod	getMethod()	Http method for the API.
default TaskInput	getQueryParameters()	Query strings attatched to end of request.
default TaskInput	getRequestBody()	HTTP Request body.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getMethod

@Stability(Stable)
@NotNull
HttpMethod getMethod()

Http method for the API.

getApiPath

@Stability(Stable)
@Nullable
default String getApiPath()

Path parameters appended after API endpoint.

Default: - No path

getAuthType

@Stability(Stable)
@Nullable
default AuthType getAuthType()

Authentication methods.

Default: AuthType.NO_AUTH

getHeaders

@Stability(Stable)
@Nullable
default TaskInput getHeaders()

HTTP request information that does not relate to contents of the request.

Default: - No headers

getQueryParameters

@Stability(Stable)
@Nullable
default TaskInput getQueryParameters()

Query strings attatched to end of request.

Default: - No query parameters

getRequestBody

@Stability(Stable)
@Nullable
default TaskInput getRequestBody()

HTTP Request body.

Default: - No request body

builder

@Stability(Stable)
static CallApiGatewayEndpointBaseProps.Builder builder()

Returns:

a CallApiGatewayEndpointBaseProps.Builder of CallApiGatewayEndpointBaseProps