Table of Contents

Interface IAwsIntegrationProps

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll
public interface IAwsIntegrationProps

Examples

var getMessageIntegration = new AwsIntegration(new AwsIntegrationProps {
                Service = "sqs",
                Path = "queueName",
                Region = "eu-west-1"
            });

Remarks

ExampleMetadata: infused

Properties

Action

The AWS action to perform in the integration.

string? Action { get; }

Property Value

string

Remarks

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

Mutually exclusive with path.

ActionParameters

Parameters for the action.

IDictionary<string, string>? ActionParameters { get; }

Property Value

IDictionary<string, string>

Remarks

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

IntegrationHttpMethod

The integration's HTTP method type.

string? IntegrationHttpMethod { get; }

Property Value

string

Remarks

Default: POST

Options

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

IIntegrationOptions? Options { get; }

Property Value

IIntegrationOptions

Path

The path to use for path-base APIs.

string? Path { get; }

Property Value

string

Remarks

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

Use AWS_PROXY integration.

bool? Proxy { get; }

Property Value

bool?

Remarks

Default: false

Region

The region of the integrated AWS service.

string? Region { get; }

Property Value

string

Remarks

Default: - same region as the stack

Service

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

string Service { get; }

Property Value

string

Subdomain

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

string? Subdomain { get; }

Property Value

string