Package software.amazon.awscdk.services.ecs

Interface ExistingCloudMapNamespaceOptions

All Superinterfaces:

CloudMapNamespaceOptionsBase, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ExistingCloudMapNamespaceOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-07-31T10:49:29.155Z")
@Stability(Stable)
public interface ExistingCloudMapNamespaceOptions
extends software.amazon.jsii.JsiiSerializable, CloudMapNamespaceOptionsBase

The options for using an existing AWS Cloud Map namespace as the default namespace of a cluster.

Example:

 Vpc vpc;
 // Create or reference an existing namespace
 PrivateDnsNamespace existingNamespace = PrivateDnsNamespace.Builder.create(this, "Namespace")
         .name("example.local")
         .vpc(vpc)
         .build();
 Cluster cluster = Cluster.Builder.create(this, "Cluster").vpc(vpc).build();
 // Use the existing namespace as the default
 cluster.addExistingDefaultCloudMapNamespace(ExistingCloudMapNamespaceOptions.builder()
         .namespace(existingNamespace)
         .useForServiceConnect(true)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ExistingCloudMapNamespaceOptions.Builder	builder()
INamespace	getNamespace()	The existing Cloud Map namespace to use as the cluster's default namespace.

Methods inherited from interface software.amazon.awscdk.services.ecs.CloudMapNamespaceOptionsBase

getUseForServiceConnect

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNamespace

@Stability(Stable)
@NotNull
INamespace getNamespace()

The existing Cloud Map namespace to use as the cluster's default namespace.

The full INamespace is required (rather than a ref) because the cluster needs the namespace name, ARN and type to wire up Service Discovery and Service Connect.

[disable-awslint:prefer-ref-interface]

builder

@Stability(Stable)
static ExistingCloudMapNamespaceOptions.Builder builder()

Returns:

a ExistingCloudMapNamespaceOptions.Builder of ExistingCloudMapNamespaceOptions