Package software.amazon.awscdk.services.apigateway

Interface EndpointConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EndpointConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:31.479Z")
@Stability(Stable)
public interface EndpointConfiguration
extends software.amazon.jsii.JsiiSerializable

The endpoint configuration of a REST API, including VPCs and endpoint types.

EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.

Example:

 IVpcEndpoint someEndpoint;
 RestApi api = RestApi.Builder.create(this, "api")
         .endpointConfiguration(EndpointConfiguration.builder()
                 .types(List.of(EndpointType.PRIVATE))
                 .vpcEndpoints(List.of(someEndpoint))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EndpointConfiguration.Builder	builder()
default IpAddressType	getIpAddressType()	The IP address types that can invoke the API.
List<EndpointType>	getTypes()	A list of endpoint types of an API or its custom domain name.
default List<IVpcEndpoint>	getVpcEndpoints()	A list of VPC Endpoints against which to create Route53 ALIASes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTypes

@Stability(Stable)
@NotNull
List<EndpointType> getTypes()

A list of endpoint types of an API or its custom domain name.

Default: EndpointType.EDGE

getIpAddressType

@Stability(Stable)
@Nullable
default IpAddressType getIpAddressType()

The IP address types that can invoke the API.

Default: undefined - AWS default is DUAL_STACK for private API, IPV4 for all other APIs.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-ip-address-type.html

getVpcEndpoints

@Stability(Stable)
@Nullable
default List<IVpcEndpoint> getVpcEndpoints()

A list of VPC Endpoints against which to create Route53 ALIASes.

Default: - no ALIASes are created for the endpoint.

builder

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

Returns:

a EndpointConfiguration.Builder of EndpointConfiguration