@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:48.198Z") public class CfnPublicDnsNamespace extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnPublicDnsNamespace.Builder
A fluent builder for
CfnPublicDnsNamespace . |
static interface |
CfnPublicDnsNamespace.PropertiesProperty
Properties for the public DNS namespace.
|
static interface |
CfnPublicDnsNamespace.PublicDnsPropertiesMutableProperty
DNS properties for the public DNS namespace.
|
static interface |
CfnPublicDnsNamespace.SOAProperty
Start of Authority (SOA) properties for a public or private DNS namespace.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnPublicDnsNamespace(Construct scope,
java.lang.String id,
CfnPublicDnsNamespaceProps props)
Create a new `AWS::ServiceDiscovery::PublicDnsNamespace`.
|
protected |
CfnPublicDnsNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnPublicDnsNamespace(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the public namespace.
|
java.lang.String |
getAttrHostedZoneId()
The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
|
java.lang.String |
getAttrId()
The ID of the public namespace.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A description for the namespace.
|
java.lang.String |
getName()
The name that you want to assign to this namespace.
|
java.lang.Object |
getProperties()
Properties for the public DNS namespace.
|
TagManager |
getTags()
The tags for the namespace.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.String value)
A description for the namespace.
|
void |
setName(java.lang.String value)
The name that you want to assign to this namespace.
|
void |
setProperties(CfnPublicDnsNamespace.PropertiesProperty value)
Properties for the public DNS namespace.
|
void |
setProperties(IResolvable value)
Properties for the public DNS namespace.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnPublicDnsNamespace(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPublicDnsNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnPublicDnsNamespace(Construct scope, java.lang.String id, CfnPublicDnsNamespaceProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrHostedZoneId()
public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
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.
public java.lang.String getName()
Do not include sensitive information in the name. The name is publicly available using DNS queries.
public void setName(java.lang.String value)
Do not include sensitive information in the name. The name is publicly available using DNS queries.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Object getProperties()
public void setProperties(IResolvable value)
public void setProperties(CfnPublicDnsNamespace.PropertiesProperty value)