software.amazon.awscdk.services.apigateway

Interface AwsIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AwsIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.087Z")
 @Stability(value=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

Nested Classes

Modifier and Type	Interface and Description
static class	AwsIntegrationProps.Builder A builder for AwsIntegrationProps
static class	AwsIntegrationProps.Jsii$Proxy An implementation for AwsIntegrationProps

Method Summary

Modifier and Type	Method and Description
static AwsIntegrationProps.Builder	builder()
default String	getAction() The AWS action to perform in the integration.
default Map<String,String>	getActionParameters() Parameters for the action.
default String	getIntegrationHttpMethod() The integration's HTTP method type.
default IntegrationOptions	getOptions() 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	getRegion() The region of the integrated AWS service.
String	getService() The name of the integrated AWS service (e.g.
default String	getSubdomain() A designated subdomain supported by certain AWS service for fast host-name lookup.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getService

@Stability(value=Stable)
 @NotNull
String getService()

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

getAction

@Stability(value=Stable)
 @Nullable
default String getAction()

The AWS action to perform in the integration.

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

Mutually exclusive with path.

getActionParameters

@Stability(value=Stable)
 @Nullable
default Map<String,String> getActionParameters()

Parameters for the action.

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

getIntegrationHttpMethod

@Stability(value=Stable)
 @Nullable
default String getIntegrationHttpMethod()

The integration's HTTP method type.

Default: POST

getOptions

@Stability(value=Stable)
 @Nullable
default IntegrationOptions getOptions()

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

getPath

@Stability(value=Stable)
 @Nullable
default String 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 to 2015-03-31/functions/${function-arn}/invocations

Mutually exclusive with the action options.

getProxy

@Stability(value=Stable)
 @Nullable
default Boolean getProxy()

Use AWS_PROXY integration.

Default: false

getRegion

@Stability(value=Stable)
 @Nullable
default String getRegion()

The region of the integrated AWS service.

Default: - same region as the stack

getSubdomain

@Stability(value=Stable)
 @Nullable
default String getSubdomain()

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

builder

@Stability(value=Stable)
static AwsIntegrationProps.Builder builder()

Returns:

a AwsIntegrationProps.Builder of AwsIntegrationProps