Class AwsIntegrationProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

public class AwsIntegrationProps : IAwsIntegrationProps

Inheritance

object

AwsIntegrationProps

Implements

IAwsIntegrationProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

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

Remarks

ExampleMetadata: infused

Constructors

AwsIntegrationProps()

public AwsIntegrationProps()

Properties

Action

The AWS action to perform in the integration.

public string? Action { get; set; }

Property Value

string

Remarks

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

Mutually exclusive with path.

ActionParameters

Parameters for the action.

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

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.

public string? IntegrationHttpMethod { get; set; }

Property Value

string

Remarks

Default: POST

Options

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

public IIntegrationOptions? Options { get; set; }

Property Value

IIntegrationOptions

Path

The path to use for path-base APIs.

public string? Path { get; set; }

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.

public bool? Proxy { get; set; }

Property Value

bool?

Remarks

Default: false

Region

The region of the integrated AWS service.

public string? Region { get; set; }

Property Value

string

Remarks

Default: - same region as the stack

Service

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

public string Service { get; set; }

Property Value

string

Subdomain

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

public string? Subdomain { get; set; }

Property Value

string