aws-cdk-lib.aws_servicediscovery.CfnPrivateDnsNamespaceProps

CfnPrivateDnsNamespaceProps Struct

Properties for defining a CfnPrivateDnsNamespace.

Source

Generated code

Type last changed

v2.268.0 · 2 Sep 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_servicediscovery as servicediscovery } from 'aws-cdk-lib';
const cfnPrivateDnsNamespaceProps: servicediscovery.CfnPrivateDnsNamespaceProps = {
  name: 'name',

  // the properties below are optional
  description: 'description',
  properties: {
    dnsProperties: {
      soa: {
        ttl: 123,
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpc: 'vpc',
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A description for the namespace.

namestringnamestrnameStringNamestringName*stringrequired#

The name that you want to assign to this namespace.

When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

propertiesIResolvable | CfnPrivateDnsNamespace.PropertiesPropertypropertiestyping.Union[IResolvable, PropertiesProperty]propertiesIResolvablePropertiesIResolvablePropertiesinterface{}#

Properties for the private DNS namespace.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

The tags for the namespace.

Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

vpcstringvpcstrvpcStringVpcstringVpc*string#

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

Used as props by

• CfnPrivateDnsNamespace