Package software.amazon.awscdk.services.apigateway

Interface AwsIntegrationProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AwsIntegrationProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:02.491Z") @Stability(Stable) public interface AwsIntegrationProps extends software.amazon.jsii.JsiiSerializable
Example: 

 AwsIntegration getMessageIntegration = AwsIntegration.Builder.create()
         .service("sqs")
         .path("queueName")
         .region("eu-west-1")
         .build();

  • Method Details

    • getService

      @Stability(Stable) @NotNull String getService()
      The name of the integrated AWS service (e.g. s3).

    • getAction

      @Stability(Stable) @Nullable default String getAction()
      The AWS action to perform in the integration.

      Use actionParams to specify key-value params for the action.

      Mutually exclusive with path.

    • getActionParameters

      @Stability(Stable) @Nullable default Map<String,String> getActionParameters()
      Parameters for the action.

      action must be set, and path must be undefined. The action params will be URL encoded.

    • getIntegrationHttpMethod

      @Stability(Stable) @Nullable default String getIntegrationHttpMethod()
      The integration's HTTP method type.

      Default: POST

    • getOptions

      @Stability(Stable) @Nullable default IntegrationOptions getOptions()
      Integration options, such as content handling, request/response mapping, etc.

    • getPath

      @Stability(Stable) @Nullable default String getPath()
      The path to use for path-base APIs.

      For example, for S3 GET, you can set path to bucket/key. For lambda, you can set path to 2015-03-31/functions/${function-arn}/invocations

      Mutually exclusive with the action options.

    • getProxy

      @Stability(Stable) @Nullable default Boolean getProxy()
      Use AWS_PROXY integration.

      Default: false

    • getRegion

      @Stability(Stable) @Nullable default String getRegion()
      The region of the integrated AWS service.

      Default: - same region as the stack

    • getSubdomain

      @Stability(Stable) @Nullable default String getSubdomain()
      A designated subdomain supported by certain AWS service for fast host-name lookup.

    • builder

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