Interface Summary
Interface	Description
AliasTargetInstanceProps
BaseInstanceProps	(experimental) Used when the resource that's associated with the service instance is accessible using values other than an IP address or a domain name (CNAME), i.e.
BaseNamespaceProps
BaseServiceProps	(experimental) Basic props needed to create a service in a given namespace.
CfnHttpNamespaceProps	Properties for defining a `AWS::ServiceDiscovery::HttpNamespace`.
CfnInstanceProps	Properties for defining a `AWS::ServiceDiscovery::Instance`.
CfnPrivateDnsNamespace.PrivateDnsPropertiesMutableProperty
CfnPrivateDnsNamespace.PropertiesProperty
CfnPrivateDnsNamespace.SOAProperty
CfnPrivateDnsNamespaceProps	Properties for defining a `AWS::ServiceDiscovery::PrivateDnsNamespace`.
CfnPublicDnsNamespace.PropertiesProperty
CfnPublicDnsNamespace.PublicDnsPropertiesMutableProperty
CfnPublicDnsNamespace.SOAProperty
CfnPublicDnsNamespaceProps	Properties for defining a `AWS::ServiceDiscovery::PublicDnsNamespace`.
CfnService.DnsConfigProperty
CfnService.DnsRecordProperty
CfnService.HealthCheckConfigProperty
CfnService.HealthCheckCustomConfigProperty
CfnServiceProps	Properties for defining a `AWS::ServiceDiscovery::Service`.
CnameInstanceBaseProps
CnameInstanceProps
DnsServiceProps	(experimental) Service props needed to create a service in a given namespace.
HealthCheckConfig	(experimental) Settings for an optional Amazon Route 53 health check.
HealthCheckCustomConfig	(experimental) Specifies information about an optional custom health check.
HttpNamespaceAttributes
HttpNamespaceProps
IHttpNamespace
IHttpNamespace.Jsii$Default	Internal default implementation for `IHttpNamespace`.
IInstance
IInstance.Jsii$Default	Internal default implementation for `IInstance`.
INamespace
INamespace.Jsii$Default	Internal default implementation for `INamespace`.
IpInstanceBaseProps
IpInstanceProps
IPrivateDnsNamespace
IPrivateDnsNamespace.Jsii$Default	Internal default implementation for `IPrivateDnsNamespace`.
IPublicDnsNamespace
IPublicDnsNamespace.Jsii$Default	Internal default implementation for `IPublicDnsNamespace`.
IService
IService.Jsii$Default	Internal default implementation for `IService`.
NonIpInstanceBaseProps
NonIpInstanceProps
PrivateDnsNamespaceAttributes
PrivateDnsNamespaceProps
PublicDnsNamespaceAttributes
PublicDnsNamespaceProps
ServiceAttributes
ServiceProps

Class Summary
Class	Description
AliasTargetInstance	(experimental) Instance that uses Route 53 Alias record type.
AliasTargetInstance.Builder	(experimental) A fluent builder for `AliasTargetInstance`.
AliasTargetInstanceProps.Builder	A builder for `AliasTargetInstanceProps`
AliasTargetInstanceProps.Jsii$Proxy	An implementation for `AliasTargetInstanceProps`
BaseInstanceProps.Builder	A builder for `BaseInstanceProps`
BaseInstanceProps.Jsii$Proxy	An implementation for `BaseInstanceProps`
BaseNamespaceProps.Builder	A builder for `BaseNamespaceProps`
BaseNamespaceProps.Jsii$Proxy	An implementation for `BaseNamespaceProps`
BaseServiceProps.Builder	A builder for `BaseServiceProps`
BaseServiceProps.Jsii$Proxy	An implementation for `BaseServiceProps`
CfnHttpNamespace	A CloudFormation `AWS::ServiceDiscovery::HttpNamespace`.
CfnHttpNamespace.Builder	A fluent builder for `CfnHttpNamespace`.
CfnHttpNamespaceProps.Builder	A builder for `CfnHttpNamespaceProps`
CfnHttpNamespaceProps.Jsii$Proxy	An implementation for `CfnHttpNamespaceProps`
CfnInstance	A CloudFormation `AWS::ServiceDiscovery::Instance`.
CfnInstance.Builder	A fluent builder for `CfnInstance`.
CfnInstanceProps.Builder	A builder for `CfnInstanceProps`
CfnInstanceProps.Jsii$Proxy	An implementation for `CfnInstanceProps`
CfnPrivateDnsNamespace	A CloudFormation `AWS::ServiceDiscovery::PrivateDnsNamespace`.
CfnPrivateDnsNamespace.Builder	A fluent builder for `CfnPrivateDnsNamespace`.
CfnPrivateDnsNamespace.PrivateDnsPropertiesMutableProperty.Builder	A builder for `CfnPrivateDnsNamespace.PrivateDnsPropertiesMutableProperty`
CfnPrivateDnsNamespace.PrivateDnsPropertiesMutableProperty.Jsii$Proxy	An implementation for `CfnPrivateDnsNamespace.PrivateDnsPropertiesMutableProperty`
CfnPrivateDnsNamespace.PropertiesProperty.Builder	A builder for `CfnPrivateDnsNamespace.PropertiesProperty`
CfnPrivateDnsNamespace.PropertiesProperty.Jsii$Proxy	An implementation for `CfnPrivateDnsNamespace.PropertiesProperty`
CfnPrivateDnsNamespace.SOAProperty.Builder	A builder for `CfnPrivateDnsNamespace.SOAProperty`
CfnPrivateDnsNamespace.SOAProperty.Jsii$Proxy	An implementation for `CfnPrivateDnsNamespace.SOAProperty`
CfnPrivateDnsNamespaceProps.Builder	A builder for `CfnPrivateDnsNamespaceProps`
CfnPrivateDnsNamespaceProps.Jsii$Proxy	An implementation for `CfnPrivateDnsNamespaceProps`
CfnPublicDnsNamespace	A CloudFormation `AWS::ServiceDiscovery::PublicDnsNamespace`.
CfnPublicDnsNamespace.Builder	A fluent builder for `CfnPublicDnsNamespace`.
CfnPublicDnsNamespace.PropertiesProperty.Builder	A builder for `CfnPublicDnsNamespace.PropertiesProperty`
CfnPublicDnsNamespace.PropertiesProperty.Jsii$Proxy	An implementation for `CfnPublicDnsNamespace.PropertiesProperty`
CfnPublicDnsNamespace.PublicDnsPropertiesMutableProperty.Builder	A builder for `CfnPublicDnsNamespace.PublicDnsPropertiesMutableProperty`
CfnPublicDnsNamespace.PublicDnsPropertiesMutableProperty.Jsii$Proxy	An implementation for `CfnPublicDnsNamespace.PublicDnsPropertiesMutableProperty`
CfnPublicDnsNamespace.SOAProperty.Builder	A builder for `CfnPublicDnsNamespace.SOAProperty`
CfnPublicDnsNamespace.SOAProperty.Jsii$Proxy	An implementation for `CfnPublicDnsNamespace.SOAProperty`
CfnPublicDnsNamespaceProps.Builder	A builder for `CfnPublicDnsNamespaceProps`
CfnPublicDnsNamespaceProps.Jsii$Proxy	An implementation for `CfnPublicDnsNamespaceProps`
CfnService	A CloudFormation `AWS::ServiceDiscovery::Service`.
CfnService.Builder	A fluent builder for `CfnService`.
CfnService.DnsConfigProperty.Builder	A builder for `CfnService.DnsConfigProperty`
CfnService.DnsConfigProperty.Jsii$Proxy	An implementation for `CfnService.DnsConfigProperty`
CfnService.DnsRecordProperty.Builder	A builder for `CfnService.DnsRecordProperty`
CfnService.DnsRecordProperty.Jsii$Proxy	An implementation for `CfnService.DnsRecordProperty`
CfnService.HealthCheckConfigProperty.Builder	A builder for `CfnService.HealthCheckConfigProperty`
CfnService.HealthCheckConfigProperty.Jsii$Proxy	An implementation for `CfnService.HealthCheckConfigProperty`
CfnService.HealthCheckCustomConfigProperty.Builder	A builder for `CfnService.HealthCheckCustomConfigProperty`
CfnService.HealthCheckCustomConfigProperty.Jsii$Proxy	An implementation for `CfnService.HealthCheckCustomConfigProperty`
CfnServiceProps.Builder	A builder for `CfnServiceProps`
CfnServiceProps.Jsii$Proxy	An implementation for `CfnServiceProps`
CnameInstance	(experimental) Instance that is accessible using a domain name (CNAME).
CnameInstance.Builder	(experimental) A fluent builder for `CnameInstance`.
CnameInstanceBaseProps.Builder	A builder for `CnameInstanceBaseProps`
CnameInstanceBaseProps.Jsii$Proxy	An implementation for `CnameInstanceBaseProps`
CnameInstanceProps.Builder	A builder for `CnameInstanceProps`
CnameInstanceProps.Jsii$Proxy	An implementation for `CnameInstanceProps`
DnsServiceProps.Builder	A builder for `DnsServiceProps`
DnsServiceProps.Jsii$Proxy	An implementation for `DnsServiceProps`
HealthCheckConfig.Builder	A builder for `HealthCheckConfig`
HealthCheckConfig.Jsii$Proxy	An implementation for `HealthCheckConfig`
HealthCheckCustomConfig.Builder	A builder for `HealthCheckCustomConfig`
HealthCheckCustomConfig.Jsii$Proxy	An implementation for `HealthCheckCustomConfig`
HttpNamespace	(experimental) Define an HTTP Namespace.
HttpNamespace.Builder	(experimental) A fluent builder for `HttpNamespace`.
HttpNamespaceAttributes.Builder	A builder for `HttpNamespaceAttributes`
HttpNamespaceAttributes.Jsii$Proxy	An implementation for `HttpNamespaceAttributes`
HttpNamespaceProps.Builder	A builder for `HttpNamespaceProps`
HttpNamespaceProps.Jsii$Proxy	An implementation for `HttpNamespaceProps`
IHttpNamespace.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IInstance.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
INamespace.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
InstanceBase
IpInstance	(experimental) Instance that is accessible using an IP address.
IpInstance.Builder	(experimental) A fluent builder for `IpInstance`.
IpInstanceBaseProps.Builder	A builder for `IpInstanceBaseProps`
IpInstanceBaseProps.Jsii$Proxy	An implementation for `IpInstanceBaseProps`
IpInstanceProps.Builder	A builder for `IpInstanceProps`
IpInstanceProps.Jsii$Proxy	An implementation for `IpInstanceProps`
IPrivateDnsNamespace.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IPublicDnsNamespace.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IService.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
NonIpInstance	(experimental) Instance accessible using values other than an IP address or a domain name (CNAME).
NonIpInstance.Builder	(experimental) A fluent builder for `NonIpInstance`.
NonIpInstanceBaseProps.Builder	A builder for `NonIpInstanceBaseProps`
NonIpInstanceBaseProps.Jsii$Proxy	An implementation for `NonIpInstanceBaseProps`
NonIpInstanceProps.Builder	A builder for `NonIpInstanceProps`
NonIpInstanceProps.Jsii$Proxy	An implementation for `NonIpInstanceProps`
PrivateDnsNamespace	(experimental) Define a Service Discovery HTTP Namespace.
PrivateDnsNamespace.Builder	(experimental) A fluent builder for `PrivateDnsNamespace`.
PrivateDnsNamespaceAttributes.Builder	A builder for `PrivateDnsNamespaceAttributes`
PrivateDnsNamespaceAttributes.Jsii$Proxy	An implementation for `PrivateDnsNamespaceAttributes`
PrivateDnsNamespaceProps.Builder	A builder for `PrivateDnsNamespaceProps`
PrivateDnsNamespaceProps.Jsii$Proxy	An implementation for `PrivateDnsNamespaceProps`
PublicDnsNamespace	(experimental) Define a Public DNS Namespace.
PublicDnsNamespace.Builder	(experimental) A fluent builder for `PublicDnsNamespace`.
PublicDnsNamespaceAttributes.Builder	A builder for `PublicDnsNamespaceAttributes`
PublicDnsNamespaceAttributes.Jsii$Proxy	An implementation for `PublicDnsNamespaceAttributes`
PublicDnsNamespaceProps.Builder	A builder for `PublicDnsNamespaceProps`
PublicDnsNamespaceProps.Jsii$Proxy	An implementation for `PublicDnsNamespaceProps`
Service	(experimental) Define a CloudMap Service.
Service.Builder	(experimental) A fluent builder for `Service`.
ServiceAttributes.Builder	A builder for `ServiceAttributes`
ServiceAttributes.Jsii$Proxy	An implementation for `ServiceAttributes`
ServiceProps.Builder	A builder for `ServiceProps`
ServiceProps.Jsii$Proxy	An implementation for `ServiceProps`

Enum Summary
Enum Description

DnsRecordType

HealthCheckType

NamespaceType

RoutingPolicy

Enum Summary
Enum	Description
DnsRecordType
HealthCheckType
NamespaceType
RoutingPolicy

Package software.amazon.awscdk.services.servicediscovery Description

Amazon ECS Service Discovery Construct Library

---

This module is part of the AWS Cloud Development Kit project.

This package contains constructs for working with AWS Cloud Map

AWS Cloud Map is a fully managed service that you can use to create and maintain a map of the backend services and resources that your applications depend on.

For further information on AWS Cloud Map, see the AWS Cloud Map documentation

HTTP Namespace Example

The following example creates an AWS Cloud Map namespace that supports API calls, creates a service in that namespace, and registers an instance to it:

Creating a Cloud Map service within an HTTP namespace

Private DNS Namespace Example

The following example creates an AWS Cloud Map namespace that supports both API calls and DNS queries within a vpc, creates a service in that namespace, and registers a loadbalancer as an instance:

Creating a Cloud Map service within a Private DNS namespace

Public DNS Namespace Example

The following example creates an AWS Cloud Map namespace that supports both API calls and public DNS queries, creates a service in that namespace, and registers an IP instance:

Creating a Cloud Map service within a Public namespace

For DNS namespaces, you can also register instances to services with CNAME records:

Creating a Cloud Map service within a Public namespace