Package software.amazon.awscdk.services.apigateway

Interface CfnDomainName.EndpointConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainName.EndpointConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDomainName

@Stability(Stable)
public static interface CfnDomainName.EndpointConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The EndpointConfiguration property type specifies the endpoint types and IP address types of an Amazon API Gateway domain name.

EndpointConfiguration is a property of the AWS::ApiGateway::DomainName 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()
         .ipAddressType("ipAddressType")
         .types(List.of("types"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomainName.EndpointConfigurationProperty.Builder	builder()
default String	getIpAddressType()	The IP address types that can invoke this DomainName.
default List<String>	getTypes()	A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpAddressType

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

The IP address types that can invoke this DomainName.

Use ipv4 to allow only IPv4 addresses to invoke this DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke this DomainName. For the PRIVATE endpoint type, only dualstack is supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-ipaddresstype

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-types

builder

@Stability(Stable)
static CfnDomainName.EndpointConfigurationProperty.Builder builder()

Returns:

a CfnDomainName.EndpointConfigurationProperty.Builder of CfnDomainName.EndpointConfigurationProperty