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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-21T06:34:16.226Z")
@Stability(Stable)
public class CfnPrivateDnsNamespace
extends CfnResource
implements IInspectable, 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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnPrivateDnsNamespace
.static interface
DNS properties for the private DNS namespace.static interface
Properties for the private DNS namespace.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnPrivateDnsNamespace
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnPrivateDnsNamespace
(software.amazon.jsii.JsiiObjectRef objRef) CfnPrivateDnsNamespace
(software.constructs.Construct scope, String id, CfnPrivateDnsNamespaceProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the private namespace.The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.The ID of the private namespace.A description for the namespace.getName()
The name that you want to assign to this namespace.Properties for the private DNS namespace.getTags()
Tag Manager which manages the tags for this resource.The tags for the namespace.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.renderProperties
(Map<String, Object> props) void
setDescription
(String value) A description for the namespace.void
The name that you want to assign to this namespace.void
setProperties
(IResolvable value) Properties for the private DNS namespace.void
Properties for the private DNS namespace.void
setTagsRaw
(List<CfnTag> value) The tags for the namespace.void
The ID of the Amazon VPC that you want to associate the namespace with.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the private namespace. -
getAttrHostedZoneId
The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace. -
getAttrId
The ID of the private namespace. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getName
The name that you want to assign to this namespace. -
setName
The name that you want to assign to this namespace. -
getVpc
The ID of the Amazon VPC that you want to associate the namespace with. -
setVpc
The ID of the Amazon VPC that you want to associate the namespace with. -
getDescription
A description for the namespace. -
setDescription
A description for the namespace. -
getProperties
Properties for the private DNS namespace. -
setProperties
Properties for the private DNS namespace. -
setProperties
@Stability(Stable) public void setProperties(@Nullable CfnPrivateDnsNamespace.PropertiesProperty value) Properties for the private DNS namespace. -
getTagsRaw
The tags for the namespace. -
setTagsRaw
The tags for the namespace.
-