aws-cdk.aws-servicediscovery

What it is and what it does

This package provides AWS CDK constructs for working with AWS Cloud Map, a managed service discovery system. It allows you to define and register backend services and resources that your applications depend on, supporting HTTP namespaces (API-only), private DNS namespaces (within a VPC), and public DNS namespaces (internet-accessible). You can create namespaces, define services within them, and register instances—whether IP-based, non-IP, load balancers, or CNAME records—all through infrastructure-as-code.

The package wraps AWS Cloud Map's API into CDK constructs that integrate with other AWS CDK modules like EC2, Elastic Load Balancing, and Route 53. It is built on the jsii bridge, allowing it to work across multiple programming languages. However, this is a v1 package that stopped receiving updates on 2023-06-01; new projects should use AWS CDK v2 instead.

Use it for:

• Define service discovery infrastructure for microservices running in ECS or on EC2 within a VPC using private DNS namespaces.
• Register load balancers as service instances so clients can discover and route traffic to them via Cloud Map.
• Set up HTTP-based service discovery for applications that need API-driven instance registration without DNS.
• Create public DNS namespaces to register and discover services accessible over the internet with health checks.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides AWS CDK constructs for defining and managing service discovery resources via AWS Cloud Map, supporting HTTP, private DNS, and public DNS namespaces with instance registration.

No, unless you are maintaining an existing AWS CDK v1 codebase. This package reached end-of-support on 2023-06-01 and is no longer updated. New projects should use AWS CDK v2's service discovery constructs instead. If you are already on v1, it remains functional and has no known vulnerabilities, but migration to v2 is strongly recommended.

Install

aws-cdk-aws-servicediscovery on PyPI

pip install aws-cdk-aws-servicediscovery

uv add aws-cdk-aws-servicediscovery

poetry add aws-cdk-aws-servicediscovery

Installing aws-cdk.aws-servicediscovery

Before you install

Low install friction with a stable dependency chain. However, this is an AWS CDK v1 package that reached end-of-support on 2023-06-01 and is no longer being updated; users should migrate to AWS CDK v2.

License in practice

Licensed under Apache-2.0 (permissive), allowing use in most projects without significant legal constraints.

Quickstart

pip install aws-cdk.aws-servicediscovery

import aws_cdk.core as cdk
import aws_cdk.aws_servicediscovery as servicediscovery

app = cdk.App()
stack = cdk.Stack(app, "stack")
namespace = servicediscovery.HttpNamespace(stack, "Namespace", name="example")
service = namespace.create_service("Service")
service.register_ip_instance("Instance", ipv4="192.0.2.1")

Requires Python 3.7 or later; AWS CDK v1 is end-of-support as of 2023-06-01 and will not receive updates.

Verify before relying

• Whether migration tooling or documentation exists to help move existing code from v1 to v2
• Whether security patches will be backported to v1 despite end-of-support status

Package facts

Evidence: aws_cdk.aws_servicediscovery-1.204.0-py3-none-any.whl

Tags

More Build Tools packages