CallApiGatewayHttpApiEndpointOptions

class aws_cdk.aws_stepfunctions_tasks.CallApiGatewayHttpApiEndpointOptions(*, api_id, api_stack, stage_name=None)

Bases: object

Base properties for calling an HTTP API Endpoint.

Parameters:

• api_id (str) – The Id of the API to call.

• api_stack (Stack) – The Stack in which the API is defined.

• stage_name (Optional[str]) – Name of the stage where the API is deployed to in API Gateway. Default: ‘$default’

ExampleMetadata:

fixture=_generated

Example:

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

# stack: cdk.Stack

call_api_gateway_http_api_endpoint_options = stepfunctions_tasks.CallApiGatewayHttpApiEndpointOptions(
    api_id="apiId",
    api_stack=stack,

    # the properties below are optional
    stage_name="stageName"
)

Attributes

api_id

The Id of the API to call.

api_stack

The Stack in which the API is defined.

stage_name

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

Default:

‘$default’