Interface CallApiGatewayEndpointBaseProps
- All Superinterfaces:
AssignableStateOptions,CallApiGatewayEndpointBaseOptions,software.amazon.jsii.JsiiSerializable,JsonataCommonOptions,JsonPathCommonOptions,StateBaseProps,TaskStateBaseOptions,TaskStateBaseProps
- All Known Subinterfaces:
CallApiGatewayHttpApiEndpointProps,CallApiGatewayRestApiEndpointProps
- All Known Implementing Classes:
CallApiGatewayEndpointBaseProps.Jsii$Proxy,CallApiGatewayHttpApiEndpointProps.Jsii$Proxy,CallApiGatewayRestApiEndpointProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-29T11:15:49.588Z")
@Stability(Stable)
public interface CallApiGatewayEndpointBaseProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps, CallApiGatewayEndpointBaseOptions
Base CallApiGatewayEndpoint 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 assign;
Object outputs;
Object resultSelector;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
CallApiGatewayEndpointBaseProps callApiGatewayEndpointBaseProps = CallApiGatewayEndpointBaseProps.builder()
.method(HttpMethod.GET)
// the properties below are optional
.apiPath("apiPath")
.assign(Map.of(
"assignKey", assign))
.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")
.outputs(outputs)
.queryLanguage(QueryLanguage.JSON_PATH)
.queryParameters(taskInput)
.requestBody(taskInput)
.resultPath("resultPath")
.resultSelector(Map.of(
"resultSelectorKey", resultSelector))
.stateName("stateName")
.taskTimeout(timeout)
.timeout(Duration.minutes(30))
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCallApiGatewayEndpointBasePropsstatic final classAn implementation forCallApiGatewayEndpointBaseProps -
Method Summary
Static MethodsMethods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssignMethods inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.CallApiGatewayEndpointBaseOptions
getApiPath, getAuthType, getHeaders, getMethod, getQueryParameters, getRequestBodyMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions
getOutputsMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions
getInputPath, getOutputPathMethods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateNameMethods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions
getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeoutMethods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps
getResultPath, getResultSelector
-
Method Details
-
builder
-