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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.134Z")
 @Stability(value=Stable)
public class CfnPrivateDnsNamespace
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ServiceDiscovery::PrivateDnsNamespace`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPrivateDnsNamespace.Builder A fluent builder for CfnPrivateDnsNamespace.
static interface	CfnPrivateDnsNamespace.PrivateDnsPropertiesMutableProperty DNS properties for the private DNS namespace.
static interface	CfnPrivateDnsNamespace.PropertiesProperty Properties for the private DNS namespace.
static interface	CfnPrivateDnsNamespace.SOAProperty Start of Authority (SOA) properties for a public or private DNS namespace.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPrivateDnsNamespace(software.constructs.Construct scope, String id, CfnPrivateDnsNamespaceProps props) Create a new `AWS::ServiceDiscovery::PrivateDnsNamespace`.
protected	CfnPrivateDnsNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPrivateDnsNamespace(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the private namespace.
String	getAttrHostedZoneId() The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
String	getAttrId() The ID of the private namespace.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description for the namespace.
String	getName() The name that you want to assign to this namespace.
Object	getProperties() Properties for the private DNS namespace.
TagManager	getTags() The tags for the namespace.
String	getVpc() The ID of the Amazon VPC that you want to associate the namespace with.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description for the namespace.
void	setName(String value) The name that you want to assign to this namespace.
void	setProperties(CfnPrivateDnsNamespace.PropertiesProperty value) Properties for the private DNS namespace.
void	setProperties(IResolvable value) Properties for the private DNS namespace.
void	setVpc(String value) The ID of the Amazon VPC that you want to associate the namespace with.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPrivateDnsNamespace

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

CfnPrivateDnsNamespace

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

CfnPrivateDnsNamespace

@Stability(value=Stable)
public CfnPrivateDnsNamespace(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id,
                                                       @NotNull
                                                       CfnPrivateDnsNamespaceProps props)

Create a new `AWS::ServiceDiscovery::PrivateDnsNamespace`.

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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the private namespace.

getAttrHostedZoneId

@Stability(value=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(value=Stable)
 @NotNull
public String getAttrId()

The ID of the private namespace.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=Stable)
 @NotNull
public String getName()

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.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

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.

getVpc

@Stability(value=Stable)
 @NotNull
public String getVpc()

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

setVpc

@Stability(value=Stable)
public void setVpc(@NotNull
                                            String value)

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description for the namespace.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the namespace.

getProperties

@Stability(value=Stable)
 @Nullable
public Object getProperties()

Properties for the private DNS namespace.

setProperties

@Stability(value=Stable)
public void setProperties(@Nullable
                                                   CfnPrivateDnsNamespace.PropertiesProperty value)

Properties for the private DNS namespace.

setProperties

@Stability(value=Stable)
public void setProperties(@Nullable
                                                   IResolvable value)

Properties for the private DNS namespace.