Interface IAwsIntegrationProps
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IAwsIntegrationProps
Syntax (vb)
Public Interface IAwsIntegrationProps
Remarks
ExampleMetadata: infused
Examples
var getMessageIntegration = new AwsIntegration(new AwsIntegrationProps {
Service = "sqs",
Path = "queueName",
Region = "eu-west-1"
});
Synopsis
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. |
Subdomain | A designated subdomain supported by certain AWS service for fast host-name lookup. |
Properties
Action
The AWS action to perform in the integration.
virtual string Action { get; }
Property Value
System.String
Remarks
Use actionParams
to specify key-value params for the action.
Mutually exclusive with path
.
ActionParameters
Parameters for the action.
virtual IDictionary<string, string> ActionParameters { get; }
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.
virtual string IntegrationHttpMethod { get; }
Property Value
System.String
Remarks
Default: POST
Options
Integration options, such as content handling, request/response mapping, etc.
virtual IIntegrationOptions Options { get; }
Property Value
Path
The path to use for path-base APIs.
virtual string Path { get; }
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.
virtual Nullable<bool> Proxy { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Region
The region of the integrated AWS service.
virtual string Region { get; }
Property Value
System.String
Remarks
Default: - same region as the stack
Service
The name of the integrated AWS service (e.g. s3
).
string Service { get; }
Property Value
System.String
Subdomain
A designated subdomain supported by certain AWS service for fast host-name lookup.
virtual string Subdomain { get; }
Property Value
System.String