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

Interface CallApiGatewayRestApiEndpointOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CallApiGatewayRestApiEndpointJsonataProps, CallApiGatewayRestApiEndpointJsonPathProps, CallApiGatewayRestApiEndpointProps

All Known Implementing Classes:

CallApiGatewayRestApiEndpointJsonataProps.Jsii$Proxy, CallApiGatewayRestApiEndpointJsonPathProps.Jsii$Proxy, CallApiGatewayRestApiEndpointOptions.Jsii$Proxy, CallApiGatewayRestApiEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:49.616Z")
@Stability(Stable)
public interface CallApiGatewayRestApiEndpointOptions
extends software.amazon.jsii.JsiiSerializable

Base properties for calling an REST API Endpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 RestApi restApi;
 CallApiGatewayRestApiEndpointOptions callApiGatewayRestApiEndpointOptions = CallApiGatewayRestApiEndpointOptions.builder()
         .api(restApi)
         .stageName("stageName")
         // the properties below are optional
         .region("region")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CallApiGatewayRestApiEndpointOptions.Builder	builder()
IRestApi	getApi()	API to call.
default String	getRegion()	Specify a custom Region where the API is deployed, e.g.
String	getStageName()	Name of the stage where the API is deployed to in API Gateway.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApi

@Stability(Stable)
@NotNull
IRestApi getApi()

API to call.

getStageName

@Stability(Stable)
@NotNull
String getStageName()

Name of the stage where the API is deployed to in API Gateway.

getRegion

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

Specify a custom Region where the API is deployed, e.g. 'us-east-1'.

Default: - Uses the Region of the stack containing the `api`.

builder

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

Returns:

a CallApiGatewayRestApiEndpointOptions.Builder of CallApiGatewayRestApiEndpointOptions