interface AwsIntegrationProps

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.AwsIntegrationProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#AwsIntegrationProps`
Java	`software.amazon.awscdk.services.apigateway.AwsIntegrationProps`
Python	`aws_cdk.aws_apigateway.AwsIntegrationProps`
TypeScript (source)	`aws-cdk-lib` » `aws_apigateway` » `AwsIntegrationProps`

Example

const getMessageIntegration = new apigateway.AwsIntegration({
  service: 'sqs',
  path: 'queueName',
  region: 'eu-west-1'
});

Name	Type	Description
service	`string`	The name of the integrated AWS service (e.g. `s3`).
action?	`string`	The AWS action to perform in the integration.
actionParameters?	`{ [string]: string }`	Parameters for the action.
integrationHttpMethod?	`string`	The integration's HTTP method type.
options?	`IntegrationOptions`	Integration options, such as content handling, request/response mapping, etc.
path?	`string`	The path to use for path-base APIs.
proxy?	`boolean`	Use AWS_PROXY integration.
region?	`string`	The region of the integrated AWS service.
subdomain?	`string`	A designated subdomain supported by certain AWS service for fast host-name lookup.

Type: string

The name of the integrated AWS service (e.g. s3).

Type: string (optional)

The AWS action to perform in the integration.

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

Mutually exclusive with path.

Type: { [string]: string } (optional)

Parameters for the action.

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

Type: string (optional, default: POST)

The integration's HTTP method type.

Type: IntegrationOptions (optional)

Integration options, such as content handling, request/response mapping, etc.

Type: string (optional)

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.

Type: boolean (optional, default: false)

Use AWS_PROXY integration.

Type: string (optional, default: same region as the stack)

The region of the integrated AWS service.

Type: string (optional)

A designated subdomain supported by certain AWS service for fast host-name lookup.