software.amazon.awscdk.services.apigateway

Interface EndpointConfiguration

All Known Implementing Classes:

EndpointConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:58.180Z")
public interface EndpointConfiguration

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

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

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EndpointConfiguration.Builder	builder()
java.util.List<EndpointType>	getTypes() A list of endpoint types of an API or its custom domain name.
default java.util.List<IVpcEndpoint>	getVpcEndpoints() A list of VPC Endpoints against which to create Route53 ALIASes.

Method Detail

getTypes

java.util.List<EndpointType> getTypes()

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

Default: EndpointType.EDGE

getVpcEndpoints

default java.util.List<IVpcEndpoint> getVpcEndpoints()

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

Default: - no ALIASes are created for the endpoint.

builder

static EndpointConfiguration.Builder builder()

Returns:

a EndpointConfiguration.Builder of EndpointConfiguration