class PrivateDnsNamespace (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ServiceDiscovery.PrivateDnsNamespace
Java	software.amazon.awscdk.services.servicediscovery.PrivateDnsNamespace
Python	aws_cdk.aws_servicediscovery.PrivateDnsNamespace
TypeScript (source)	@aws-cdk/aws-servicediscovery » PrivateDnsNamespace

Implements IConstruct, IConstruct, IDependable, IResource, IPrivateDnsNamespace, INamespace

Define a Service Discovery HTTP Namespace.

Example

// Cloud Map service discovery is currently required for host ejection by outlier detection
const vpc = new ec2.Vpc(this, 'vpc');
const namespace = new cloudmap.PrivateDnsNamespace(this, 'test-namespace', {
    vpc,
    name: 'domain.local',
});
const service = namespace.createService('Svc');

declare const mesh: appmesh.Mesh;
const node = mesh.addVirtualNode('virtual-node', {
  serviceDiscovery: appmesh.ServiceDiscovery.cloudMap(service),
  listeners: [appmesh.VirtualNodeListener.http({
    outlierDetection: {
      baseEjectionDuration: cdk.Duration.seconds(10),
      interval: cdk.Duration.seconds(30),
      maxEjectionPercent: 50,
      maxServerErrors: 5,
    },
  })],
});

Initializer

new PrivateDnsNamespace(scope: Construct, id: string, props: PrivateDnsNamespaceProps)

Parameters

• scope Construct
• id string
• props PrivateDnsNamespaceProps

Construct Props

Name	Type	Description
name	string	A name for the Namespace.
vpc	IVpc	The Amazon VPC that you want to associate the namespace with.
description?	string	A description of the Namespace.

---

name

Type: string

A name for the Namespace.

---

vpc

Type: IVpc

The Amazon VPC that you want to associate the namespace with.

---

description?

Type: string (optional, default: none)

A description of the Namespace.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
namespaceArn	string	Namespace Arn of the namespace.
namespaceId	string	Namespace Id of the PrivateDnsNamespace.
namespaceName	string	The name of the PrivateDnsNamespace.
node	ConstructNode	The construct tree node associated with this construct.
privateDnsNamespaceArn	string
privateDnsNamespaceId	string
privateDnsNamespaceName	string
stack	Stack	The stack in which this resource is defined.
type	NamespaceType	Type of the namespace.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

namespaceArn

Type: string

Namespace Arn of the namespace.

---

namespaceId

Type: string

Namespace Id of the PrivateDnsNamespace.

---

namespaceName

Type: string

The name of the PrivateDnsNamespace.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

privateDnsNamespaceArn

Type: string

---

privateDnsNamespaceId

Type: string

---

privateDnsNamespaceName

Type: string

---

stack

Type: Stack

The stack in which this resource is defined.

---

type

Type: NamespaceType

Type of the namespace.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
createService(id, props?)	Creates a service within the namespace.
toString()	Returns a string representation of this construct.
static fromPrivateDnsNamespaceAttributes(scope, id, attrs)

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

createService(id, props?)

public createService(id: string, props?: DnsServiceProps): Service

Parameters

• id string
• props DnsServiceProps

Returns

• Service

Creates a service within the namespace.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromPrivateDnsNamespaceAttributes(scope, id, attrs)

public static fromPrivateDnsNamespaceAttributes(scope: Construct, id: string, attrs: PrivateDnsNamespaceAttributes): IPrivateDnsNamespace

Parameters

• scope Construct
• id string
• attrs PrivateDnsNamespaceAttributes

Returns

• IPrivateDnsNamespace