Package software.amazon.awscdk.services.servicediscovery

Class CfnPrivateDnsNamespace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.servicediscovery.CfnPrivateDnsNamespace
All Implemented Interfaces:
IInspectable, ITaggable, IPrivateDnsNamespaceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:47.226Z") @Stability(Stable) public class CfnPrivateDnsNamespace extends CfnResource implements IInspectable, IPrivateDnsNamespaceRef, ITaggable
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.

The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend , the resulting DNS name for the service is backend.example.com . Service instances that are registered using a private DNS namespace can be discovered using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same AWS account , see AWS Cloud Map quotas in the AWS Cloud Map Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.servicediscovery.*;
 CfnPrivateDnsNamespace cfnPrivateDnsNamespace = CfnPrivateDnsNamespace.Builder.create(this, "MyCfnPrivateDnsNamespace")
         .name("name")
         .vpc("vpc")
         // the properties below are optional
         .description("description")
         .properties(PropertiesProperty.builder()
                 .dnsProperties(PrivateDnsPropertiesMutableProperty.builder()
                         .soa(SOAProperty.builder()
                                 .ttl(123)
                                 .build())
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPrivateDnsNamespace

      protected CfnPrivateDnsNamespace(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPrivateDnsNamespace

      protected CfnPrivateDnsNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPrivateDnsNamespace

      @Stability(Stable) public CfnPrivateDnsNamespace(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPrivateDnsNamespaceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the private namespace.

    • getAttrHostedZoneId

      @Stability(Stable) @NotNull public String getAttrHostedZoneId()
      The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the private namespace.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPrivateDnsNamespaceRef

      @Stability(Stable) @NotNull public PrivateDnsNamespaceReference getPrivateDnsNamespaceRef()
      A reference to a PrivateDnsNamespace resource.
      Specified by:
      getPrivateDnsNamespaceRef in interface IPrivateDnsNamespaceRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name that you want to assign to this namespace.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name that you want to assign to this namespace.

    • getVpc

      @Stability(Stable) @NotNull public String getVpc()
      The ID of the Amazon VPC that you want to associate the namespace with.

    • setVpc

      @Stability(Stable) public void setVpc(@NotNull String value)
      The ID of the Amazon VPC that you want to associate the namespace with.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the namespace.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the namespace.

    • getProperties

      @Stability(Stable) @Nullable public Object getProperties()
      Properties for the private DNS namespace.

      Returns union: either IResolvable or CfnPrivateDnsNamespace.PropertiesProperty

    • setProperties

      @Stability(Stable) public void setProperties(@Nullable IResolvable value)
      Properties for the private DNS namespace.

    • setProperties

      @Stability(Stable) public void setProperties(@Nullable CfnPrivateDnsNamespace.PropertiesProperty value)
      Properties for the private DNS namespace.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags for the namespace.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags for the namespace.