Interface AwsIntegrationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AwsIntegrationProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-04T00:39:26.937Z")
@Stability(Stable)
public interface AwsIntegrationProps
extends software.amazon.jsii.JsiiSerializable
Example:
AwsIntegration getMessageIntegration = AwsIntegration.Builder.create() .service("sqs") .path("queueName") .region("eu-west-1") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forAwsIntegrationProps
static final class
An implementation forAwsIntegrationProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic AwsIntegrationProps.Builder
builder()
default String
The AWS action to perform in the integration.Parameters for the action.default String
The integration's HTTP method type.default IntegrationOptions
Integration options, such as content handling, request/response mapping, etc.default String
getPath()
The path to use for path-base APIs.default Boolean
getProxy()
Use AWS_PROXY integration.default String
The region of the integrated AWS service.The name of the integrated AWS service (e.g.default String
A designated subdomain supported by certain AWS service for fast host-name lookup.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getService
The name of the integrated AWS service (e.g.s3
). -
getAction
The AWS action to perform in the integration.Use
actionParams
to specify key-value params for the action.Mutually exclusive with
path
. -
getActionParameters
Parameters for the action.action
must be set, andpath
must be undefined. The action params will be URL encoded. -
getIntegrationHttpMethod
The integration's HTTP method type.Default: POST
-
getOptions
Integration options, such as content handling, request/response mapping, etc. -
getPath
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 to2015-03-31/functions/${function-arn}/invocations
Mutually exclusive with the
action
options. -
getProxy
Use AWS_PROXY integration.Default: false
-
getRegion
The region of the integrated AWS service.Default: - same region as the stack
-
getSubdomain
A designated subdomain supported by certain AWS service for fast host-name lookup. -
builder
- Returns:
- a
AwsIntegrationProps.Builder
ofAwsIntegrationProps
-