CallApiGatewayRestApiEndpointOptions

class aws_cdk.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpointOptions(*, api, stage_name, region=None)

Bases: object

Base properties for calling an REST API Endpoint.

Parameters:

api (IRestApi) – API to call.
stage_name (str) – Name of the stage where the API is deployed to in API Gateway.
region (Optional[str]) – Specify a custom Region where the API is deployed, e.g. ‘us-east-1’. Default: - Uses the Region of the stack containing the api.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigateway as apigateway
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# rest_api: apigateway.RestApi

call_api_gateway_rest_api_endpoint_options = stepfunctions_tasks.CallApiGatewayRestApiEndpointOptions(
    api=rest_api,
    stage_name="stageName",

    # the properties below are optional
    region="region"
)

Attributes

api: API to call.

region

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

Default:

Uses the Region of the stack containing the api.

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