Package software.amazon.awscdk.services.servicediscovery

Class CfnPublicDnsNamespace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.servicediscovery.CfnPublicDnsNamespace
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.605Z") @Stability(Stable) public class CfnPublicDnsNamespace extends CfnResource implements IInspectable
A CloudFormation AWS::ServiceDiscovery::PublicDnsNamespace.

Creates a public namespace based on DNS, which is visible on the internet. 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 . You can discover instances that were registered with a public DNS namespace by 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 .

The CreatePublicDnsNamespace API operation is not supported in the AWS GovCloud (US) Regions.

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.*;
 CfnPublicDnsNamespace cfnPublicDnsNamespace = CfnPublicDnsNamespace.Builder.create(this, "MyCfnPublicDnsNamespace")
         .name("name")
         // the properties below are optional
         .description("description")
         .properties(PropertiesProperty.builder()
                 .dnsProperties(PublicDnsPropertiesMutableProperty.builder()
                         .soa(SOAProperty.builder()
                                 .ttl(123)
                                 .build())
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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

    • CfnPublicDnsNamespace

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

    • CfnPublicDnsNamespace

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

    • CfnPublicDnsNamespace

      @Stability(Stable) public CfnPublicDnsNamespace(@NotNull Construct scope, @NotNull String id, @NotNull CfnPublicDnsNamespaceProps props)
      Create a new AWS::ServiceDiscovery::PublicDnsNamespace.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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 public 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 public namespace.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      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.

    • getName

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

      Do not include sensitive information in the name. The name is publicly available using DNS queries.

    • setName

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

      Do not include sensitive information in the name. The name is publicly available using DNS queries.

    • 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 public DNS namespace.

    • setProperties

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

    • setProperties

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