aws-cdk-lib.aws_apigateway.AwsIntegrationProps

interface AwsIntegrationProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.AwsIntegrationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#AwsIntegrationProps
Javasoftware.amazon.awscdk.services.apigateway.AwsIntegrationProps
Pythonaws_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'
});

Properties

NameTypeDescription
servicestringThe name of the integrated AWS service (e.g. s3).
action?stringThe AWS action to perform in the integration.
actionParameters?{ [string]: string }Parameters for the action.
integrationHttpMethod?stringThe integration's HTTP method type.
options?IntegrationOptionsIntegration options, such as content handling, request/response mapping, etc.
path?stringThe path to use for path-base APIs.
proxy?booleanUse AWS_PROXY integration.
region?stringThe region of the integrated AWS service.
subdomain?stringA designated subdomain supported by certain AWS service for fast host-name lookup.

service

Type: string

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


action?

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.


actionParameters?

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

Parameters for the action.

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


integrationHttpMethod?

Type: string (optional, default: POST)

The integration's HTTP method type.


options?

Type: IntegrationOptions (optional)

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


path?

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.


proxy?

Type: boolean (optional, default: false)

Use AWS_PROXY integration.


region?

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

The region of the integrated AWS service.


subdomain?

Type: string (optional)

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