Interface CfnRestApi.EndpointConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnRestApi.EndpointConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnRestApi

@Stability(Stable) public static interface CfnRestApi.EndpointConfigurationProperty extends software.amazon.jsii.JsiiSerializable
The EndpointConfiguration property type specifies the endpoint types of a REST API.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 EndpointConfigurationProperty endpointConfigurationProperty = EndpointConfigurationProperty.builder()
         .types(List.of("types"))
         .vpcEndpointIds(List.of("vpcEndpointIds"))
         .build();
 
  • Method Details

    • getTypes

      @Stability(Stable) @Nullable default List<String> getTypes()
      A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

      For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

    • getVpcEndpointIds

      @Stability(Stable) @Nullable default List<String> getVpcEndpointIds()
      A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes.

      It is only supported for PRIVATE endpoint type.

    • builder

      @Stability(Stable) static CfnRestApi.EndpointConfigurationProperty.Builder builder()
      Returns:
      a CfnRestApi.EndpointConfigurationProperty.Builder of CfnRestApi.EndpointConfigurationProperty