Package software.amazon.awscdk.services.apigatewayv2

Enum HttpIntegrationSubtype

java.lang.Object

java.lang.Enum<HttpIntegrationSubtype>

software.amazon.awscdk.services.apigatewayv2.HttpIntegrationSubtype

All Implemented Interfaces:

Serializable, Comparable<HttpIntegrationSubtype>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.175Z")
@Stability(Stable)
public enum HttpIntegrationSubtype
extends Enum<HttpIntegrationSubtype>

Supported integration subtypes.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_integrations.HttpStepFunctionsIntegration;
 import software.amazon.awscdk.services.stepfunctions.*;
 StateMachine stateMachine;
 HttpApi httpApi;
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/start")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpStepFunctionsIntegration.Builder.create("StartExecutionIntegration")
                 .stateMachine(stateMachine)
                 .subtype(HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION)
                 .build())
         .build());
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/start-sync")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpStepFunctionsIntegration.Builder.create("StartSyncExecutionIntegration")
                 .stateMachine(stateMachine)
                 .subtype(HttpIntegrationSubtype.STEPFUNCTIONS_START_SYNC_EXECUTION)
                 .build())
         .build());
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/stop")
         .methods(List.of(HttpMethod.POST))
         .integration(HttpStepFunctionsIntegration.Builder.create("StopExecutionIntegration")
                 .stateMachine(stateMachine)
                 .subtype(HttpIntegrationSubtype.STEPFUNCTIONS_STOP_EXECUTION)
                 // For the `STOP_EXECUTION` subtype, it is necessary to specify the `executionArn`.
                 .parameterMapping(new ParameterMapping().custom("ExecutionArn", "$request.querystring.executionArn"))
                 .build())
         .build());
 

See Also:

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
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.

Method Summary

Modifier and Type	Method	Description
static HttpIntegrationSubtype	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HttpIntegrationSubtype[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EVENTBRIDGE_PUT_EVENTS

@Stability(Stable)
public static final HttpIntegrationSubtype EVENTBRIDGE_PUT_EVENTS

EventBridge PutEvents integration.

SQS_SEND_MESSAGE

@Stability(Stable)
public static final HttpIntegrationSubtype SQS_SEND_MESSAGE

SQS SendMessage integration.

SQS_RECEIVE_MESSAGE

@Stability(Stable)
public static final HttpIntegrationSubtype SQS_RECEIVE_MESSAGE

SQS ReceiveMessage integration,.

SQS_DELETE_MESSAGE

@Stability(Stable)
public static final HttpIntegrationSubtype SQS_DELETE_MESSAGE

SQS DeleteMessage integration,.

SQS_PURGE_QUEUE

@Stability(Stable)
public static final HttpIntegrationSubtype SQS_PURGE_QUEUE

SQS PurgeQueue integration.

APPCONFIG_GET_CONFIGURATION

@Stability(Stable)
public static final HttpIntegrationSubtype APPCONFIG_GET_CONFIGURATION

AppConfig GetConfiguration integration.

KINESIS_PUT_RECORD

@Stability(Stable)
public static final HttpIntegrationSubtype KINESIS_PUT_RECORD

Kinesis PutRecord integration.

STEPFUNCTIONS_START_EXECUTION

@Stability(Stable)
public static final HttpIntegrationSubtype STEPFUNCTIONS_START_EXECUTION

Step Functions StartExecution integration.

STEPFUNCTIONS_START_SYNC_EXECUTION

@Stability(Stable)
public static final HttpIntegrationSubtype STEPFUNCTIONS_START_SYNC_EXECUTION

Step Functions StartSyncExecution integration.

STEPFUNCTIONS_STOP_EXECUTION

@Stability(Stable)
public static final HttpIntegrationSubtype STEPFUNCTIONS_STOP_EXECUTION

Step Functions StopExecution integration.

Method Details

values

public static HttpIntegrationSubtype[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpIntegrationSubtype valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null