Interface StepFunctionsExecutionIntegrationOptions

All Superinterfaces:
IntegrationOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
StepFunctionsExecutionIntegrationOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:46.713Z") @Stability(Stable) public interface StepFunctionsExecutionIntegrationOptions extends software.amazon.jsii.JsiiSerializable, IntegrationOptions
Options when configuring Step Functions synchronous integration with Rest API.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.services.iam.*;
 Role role;
 VpcLink vpcLink;
 StepFunctionsExecutionIntegrationOptions stepFunctionsExecutionIntegrationOptions = StepFunctionsExecutionIntegrationOptions.builder()
         .authorizer(false)
         .cacheKeyParameters(List.of("cacheKeyParameters"))
         .cacheNamespace("cacheNamespace")
         .connectionType(ConnectionType.INTERNET)
         .contentHandling(ContentHandling.CONVERT_TO_BINARY)
         .credentialsPassthrough(false)
         .credentialsRole(role)
         .headers(false)
         .integrationResponses(List.of(IntegrationResponse.builder()
                 .statusCode("statusCode")
                 // the properties below are optional
                 .contentHandling(ContentHandling.CONVERT_TO_BINARY)
                 .responseParameters(Map.of(
                         "responseParametersKey", "responseParameters"))
                 .responseTemplates(Map.of(
                         "responseTemplatesKey", "responseTemplates"))
                 .selectionPattern("selectionPattern")
                 .build()))
         .passthroughBehavior(PassthroughBehavior.WHEN_NO_MATCH)
         .path(false)
         .querystring(false)
         .requestContext(RequestContext.builder()
                 .accountId(false)
                 .apiId(false)
                 .apiKey(false)
                 .authorizerPrincipalId(false)
                 .caller(false)
                 .cognitoAuthenticationProvider(false)
                 .cognitoAuthenticationType(false)
                 .cognitoIdentityId(false)
                 .cognitoIdentityPoolId(false)
                 .httpMethod(false)
                 .requestId(false)
                 .resourceId(false)
                 .resourcePath(false)
                 .sourceIp(false)
                 .stage(false)
                 .user(false)
                 .userAgent(false)
                 .userArn(false)
                 .build())
         .requestParameters(Map.of(
                 "requestParametersKey", "requestParameters"))
         .requestTemplates(Map.of(
                 "requestTemplatesKey", "requestTemplates"))
         .timeout(Duration.minutes(30))
         .useDefaultMethodResponses(false)
         .vpcLink(vpcLink)
         .build();
 
  • Method Details

    • getAuthorizer

      @Stability(Stable) @Nullable default Boolean getAuthorizer()
      If the whole authorizer object, including custom context values should be in the execution input.

      The execution input will include a new key authorizer:

      { "body": {}, "authorizer": { "key": "value" } }

      Default: false

    • getHeaders

      @Stability(Stable) @Nullable default Boolean getHeaders()
      Check if header is to be included inside the execution input.

      The execution input will include a new key headers:

      { "body": {}, "headers": { "header1": "value", "header2": "value" } }

      Default: false

    • getPath

      @Stability(Stable) @Nullable default Boolean getPath()
      Check if path is to be included inside the execution input.

      The execution input will include a new key path:

      { "body": {}, "path": { "resourceName": "resourceValue" } }

      Default: true

    • getQuerystring

      @Stability(Stable) @Nullable default Boolean getQuerystring()
      Check if querystring is to be included inside the execution input.

      The execution input will include a new key queryString:

      { "body": {}, "querystring": { "key": "value" } }

      Default: true

    • getRequestContext

      @Stability(Stable) @Nullable default RequestContext getRequestContext()
      Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.

      The execution input will include a new key requestContext:

      { "body": {}, "requestContext": { "key": "value" } }

      Default: - all parameters within request context will be set as false

    • getUseDefaultMethodResponses

      @Stability(Stable) @Nullable default Boolean getUseDefaultMethodResponses()
      Whether to add default response models with 200, 400, and 500 status codes to the method.

      Default: true

    • builder

      @Stability(Stable) static StepFunctionsExecutionIntegrationOptions.Builder builder()
      Returns:
      a StepFunctionsExecutionIntegrationOptions.Builder of StepFunctionsExecutionIntegrationOptions