AwsIntegrationProps Struct
Example
ts
const getMessageIntegration = new apigateway.AwsIntegration({
service: 'sqs',
path: 'queueName',
region: 'eu-west-1'
});
Properties
The AWS action to perform in the integration.
Use actionParams to specify key-value params for the action.
Mutually exclusive with path.
actionParametersoptional{ [key: string]: string }action_parametersoptionaltyping.Mapping[str, str]actionParametersoptionalMap<String, String>ActionParametersoptionalIDictionary<string, string>ActionParametersoptional*map[string]*string#Parameters for the action.
action must be set, and path must be undefined. The action params will be URL encoded.
integrationHttpMethodoptionalstringintegration_http_methodoptionalstrintegrationHttpMethodoptionalStringIntegrationHttpMethodoptionalstringIntegrationHttpMethodoptional*string= POST#The integration's HTTP method type.
optionsoptionalIntegrationOptionsoptionsoptionalIntegrationOptionsoptionsoptionalIntegrationOptionsOptionsoptionalIntegrationOptionsOptionsoptionalIntegrationOptions#Integration options, such as content handling, request/response mapping, etc.
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.
proxyoptionalbooleanproxyoptionalboolproxyoptionalBooleanProxyoptionalboolProxyoptional*bool= false#Use AWS_PROXY integration.
The region of the integrated AWS service.
Default: same region as the stack
The name of the integrated AWS service (e.g. `s3`).
subdomainoptionalstringsubdomainoptionalstrsubdomainoptionalStringSubdomainoptionalstringSubdomainoptional*string#A designated subdomain supported by certain AWS service for fast host-name lookup.