Package software.amazon.awscdk.services.apigateway

Interface IntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:56.216Z")
@Stability(Stable)
public interface IntegrationProps
extends software.amazon.jsii.JsiiSerializable

Example:

 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 Vpc vpc = new Vpc(this, "VPC");
 NetworkLoadBalancer nlb = NetworkLoadBalancer.Builder.create(this, "NLB")
         .vpc(vpc)
         .build();
 VpcLink link = VpcLink.Builder.create(this, "link")
         .targets(List.of(nlb))
         .build();
 Integration integration = Integration.Builder.create()
         .type(IntegrationType.HTTP_PROXY)
         .integrationHttpMethod("ANY")
         .options(IntegrationOptions.builder()
                 .connectionType(ConnectionType.VPC_LINK)
                 .vpcLink(link)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IntegrationProps.Builder	builder()
default String	getIntegrationHttpMethod()	The integration's HTTP method type.
default IntegrationOptions	getOptions()	Integration options.
IntegrationType	getType()	Specifies an API method integration type.
default Object	getUri()	The Uniform Resource Identifier (URI) for the integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
IntegrationType getType()

Specifies an API method integration type.

getIntegrationHttpMethod

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

The integration's HTTP method type.

Required unless you use a MOCK integration.

getOptions

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

Integration options.

getUri

@Stability(Stable)
@Nullable
default Object getUri()

The Uniform Resource Identifier (URI) for the integration.

• If you specify HTTP for the type property, specify the API endpoint URL.
• If you specify MOCK for the type property, don't specify this property.
• If you specify AWS for the type property, specify an AWS service that follows this form: arn:partition:apigateway:region:subdomain.service|service:path|action/service_api. For example, a Lambda function URI follows this form: arn:partition:apigateway:region:lambda:path/path. The path is usually in the form /2015-03-31/functions/LambdaFunctionARN/invocations.

See Also:

• https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri

builder

@Stability(Stable)
static IntegrationProps.Builder builder()

Returns:

a IntegrationProps.Builder of IntegrationProps