software.amazon.awscdk.services.apigateway

Interface CfnRestApi.EndpointConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRestApi.EndpointConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnRestApi

@Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRestApi.EndpointConfigurationProperty.Builder	builder()
default List<String>	getTypes() A list of endpoint types of an API or its custom domain name.
default List<String>	getVpcEndpointIds() A list of VPC endpoint IDs of an API ( [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) ) against which to create Route53 ALIASes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTypes

@Stability(value=Stable)
 @Nullable
default List<String> getTypes()

A list of endpoint types of an API or its custom domain name. Valid values include:.

• EDGE : For an edge-optimized API and its custom domain name.
• REGIONAL : For a regional API and its custom domain name.
• PRIVATE : For a private API.

getVpcEndpointIds

@Stability(value=Stable)
 @Nullable
default List<String> getVpcEndpointIds()

A list of VPC endpoint IDs of an API ( [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) ) against which to create Route53 ALIASes. It is only supported for `PRIVATE` endpoint type.

builder

@Stability(value=Stable)
static CfnRestApi.EndpointConfigurationProperty.Builder builder()

Returns:

a CfnRestApi.EndpointConfigurationProperty.Builder of CfnRestApi.EndpointConfigurationProperty