Class AwsIntegrationProps

Inheritance

System.Object

AwsIntegrationProps

Implements

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class AwsIntegrationProps : Object, IAwsIntegrationProps

Syntax (vb)

Public Class AwsIntegrationProps
    Inherits Object
    Implements IAwsIntegrationProps

Remarks

ExampleMetadata: infused

Examples

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

Synopsis

Constructors

AwsIntegrationProps()

Properties

Action	The AWS action to perform in the integration.
ActionParameters	Parameters for the action.
IntegrationHttpMethod	The integration's HTTP method type.
Options	Integration options, such as content handling, request/response mapping, etc.
Path	The path to use for path-base APIs.
Proxy	Use AWS_PROXY integration.
Region	The region of the integrated AWS service.
Service	The name of the integrated AWS service (e.g. `s3`).
Subdomain	A designated subdomain supported by certain AWS service for fast host-name lookup.

Constructors

AwsIntegrationProps()

public AwsIntegrationProps()

Properties

Action

The AWS action to perform in the integration.

public string Action { get; set; }

Property Value

System.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

System.Collections.Generic.IDictionary<System.String, System.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

System.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

System.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 Nullable<bool> Proxy { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Region

The region of the integrated AWS service.

public string Region { get; set; }

Property Value

System.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

System.String

Subdomain

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

public string Subdomain { get; set; }

Property Value

System.String

Implements

IAwsIntegrationProps