HttpIntegrationSubtype

class aws_cdk.aws_apigatewayv2.HttpIntegrationSubtype(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Supported integration subtypes.

See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html
ExampleMetadata:: infused

Example:

from aws_cdk.aws_apigatewayv2_integrations import HttpStepFunctionsIntegration
import aws_cdk.aws_stepfunctions as sfn

# state_machine: sfn.StateMachine
# http_api: apigwv2.HttpApi


http_api.add_routes(
    path="/start",
    methods=[apigwv2.HttpMethod.POST],
    integration=HttpStepFunctionsIntegration("StartExecutionIntegration",
        state_machine=state_machine,
        subtype=apigwv2.HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION
    )
)

http_api.add_routes(
    path="/start-sync",
    methods=[apigwv2.HttpMethod.POST],
    integration=HttpStepFunctionsIntegration("StartSyncExecutionIntegration",
        state_machine=state_machine,
        subtype=apigwv2.HttpIntegrationSubtype.STEPFUNCTIONS_START_SYNC_EXECUTION
    )
)

http_api.add_routes(
    path="/stop",
    methods=[apigwv2.HttpMethod.POST],
    integration=HttpStepFunctionsIntegration("StopExecutionIntegration",
        state_machine=state_machine,
        subtype=apigwv2.HttpIntegrationSubtype.STEPFUNCTIONS_STOP_EXECUTION,
        # For the `STOP_EXECUTION` subtype, it is necessary to specify the `executionArn`.
        parameter_mapping=apigwv2.ParameterMapping().custom("ExecutionArn", "$request.querystring.executionArn")
    )
)

Attributes

APPCONFIG_GET_CONFIGURATION: AppConfig GetConfiguration integration.

EVENTBRIDGE_PUT_EVENTS: EventBridge PutEvents integration.

KINESIS_PUT_RECORD: Kinesis PutRecord integration.

SQS_DELETE_MESSAGE: SQS DeleteMessage integration,.

SQS_PURGE_QUEUE: SQS PurgeQueue integration.

SQS_RECEIVE_MESSAGE: SQS ReceiveMessage integration,.

SQS_SEND_MESSAGE: SQS SendMessage integration.

STEPFUNCTIONS_START_EXECUTION: Step Functions StartExecution integration.

STEPFUNCTIONS_START_SYNC_EXECUTION: Step Functions StartSyncExecution integration.

STEPFUNCTIONS_STOP_EXECUTION: Step Functions StopExecution integration.