class PublicDnsNamespace (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ServiceDiscovery.PublicDnsNamespace
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsservicediscovery#PublicDnsNamespace
Java	software.amazon.awscdk.services.servicediscovery.PublicDnsNamespace
Python	aws_cdk.aws_servicediscovery.PublicDnsNamespace
TypeScript (source)	aws-cdk-lib » aws_servicediscovery » PublicDnsNamespace

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IPublicDnsNamespace, INamespace

Define a Public DNS Namespace.

Example

import * as cdk from '../../core';
import * as servicediscovery from '../lib';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'aws-servicediscovery-integ');

const namespace = new servicediscovery.PublicDnsNamespace(stack, 'Namespace', {
  name: 'foobar.com',
});

const service = namespace.createService('Service', {
  name: 'foo',
  dnsRecordType: servicediscovery.DnsRecordType.A,
  dnsTtl: cdk.Duration.seconds(30),
  healthCheck: {
    type: servicediscovery.HealthCheckType.HTTPS,
    resourcePath: '/healthcheck',
    failureThreshold: 2,
  },
});

service.registerIpInstance('IpInstance', {
  ipv4: '54.239.25.192',
  port: 443,
});

app.synth();

Initializer

new PublicDnsNamespace(scope: Construct, id: string, props: PublicDnsNamespaceProps)

Parameters

• scope Construct
• id string
• props PublicDnsNamespaceProps

Construct Props

Name	Type	Description
name	string	A name for the Namespace.
description?	string	A description of the Namespace.

---

name

Type: string

A name for the Namespace.

---

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 for the namespace.
namespaceHostedZoneId	string	ID of hosted zone created by namespace.
namespaceId	string	Namespace Id for the namespace.
namespaceName	string	A name for the namespace.
node	Node	The tree node.
publicDnsNamespaceArn	string
publicDnsNamespaceId	string
publicDnsNamespaceName	string
stack	Stack	The stack in which this resource is defined.
type	NamespaceType	Type of the namespace.
static PROPERTY_INJECTION_ID	string	Uniquely identifies this class.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

namespaceArn

Type: string

Namespace Arn for the namespace.

---

namespaceHostedZoneId

Type: string

ID of hosted zone created by namespace.

---

namespaceId

Type: string

Namespace Id for the namespace.

---

namespaceName

Type: string

A name for the namespace.

---

node

Type: Node

The tree node.

---

publicDnsNamespaceArn

Type: string

---

publicDnsNamespaceId

Type: string

---

publicDnsNamespaceName

Type: string

---

stack

Type: Stack

The stack in which this resource is defined.

---

type

Type: NamespaceType

Type of the namespace.

---

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

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 fromPublicDnsNamespaceAttributes(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 fromPublicDnsNamespaceAttributes(scope, id, attrs)

public static fromPublicDnsNamespaceAttributes(scope: Construct, id: string, attrs: PublicDnsNamespaceAttributes): IPublicDnsNamespace

Parameters

• scope Construct
• id string
• attrs PublicDnsNamespaceAttributes

Returns

• IPublicDnsNamespace