Class CfnPrivateDnsNamespace
A CloudFormation AWS::ServiceDiscovery::PrivateDnsNamespace
.
Inherited Members
Namespace: Amazon.CDK.AWS.ServiceDiscovery
Assembly: Amazon.CDK.AWS.ServiceDiscovery.dll
Syntax (csharp)
public class CfnPrivateDnsNamespace : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnPrivateDnsNamespace
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::ServiceDiscovery::PrivateDnsNamespace
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ServiceDiscovery;
var cfnPrivateDnsNamespace = new CfnPrivateDnsNamespace(this, "MyCfnPrivateDnsNamespace", new CfnPrivateDnsNamespaceProps {
Name = "name",
Vpc = "vpc",
// the properties below are optional
Description = "description",
Properties = new PropertiesProperty {
DnsProperties = new PrivateDnsPropertiesMutableProperty {
Soa = new SOAProperty {
Ttl = 123
}
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnPrivateDnsNamespace(Construct, String, ICfnPrivateDnsNamespaceProps) | Create a new |
CfnPrivateDnsNamespace(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPrivateDnsNamespace(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the private namespace. |
AttrHostedZoneId | The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace. |
AttrId | The ID of the private namespace. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description for the namespace. |
Name | The name that you want to assign to this namespace. |
Properties | Properties for the private DNS namespace. |
Tags | The tags for the namespace. |
Vpc | The ID of the Amazon VPC that you want to associate the namespace with. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPrivateDnsNamespace(Construct, String, ICfnPrivateDnsNamespaceProps)
Create a new AWS::ServiceDiscovery::PrivateDnsNamespace
.
public CfnPrivateDnsNamespace(Construct scope, string id, ICfnPrivateDnsNamespaceProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnPrivateDnsNamespaceProps
- resource properties.
CfnPrivateDnsNamespace(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPrivateDnsNamespace(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPrivateDnsNamespace(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPrivateDnsNamespace(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the private namespace.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrHostedZoneId
The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
public virtual string AttrHostedZoneId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: HostedZoneId
AttrId
The ID of the private namespace.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description for the namespace.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name that you want to assign to this namespace.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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.
Properties
Properties for the private DNS namespace.
public virtual object Properties { get; set; }
Property Value
System.Object
Remarks
Tags
The tags for the namespace.
public virtual TagManager Tags { get; }
Property Value
Remarks
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.
Vpc
The ID of the Amazon VPC that you want to associate the namespace with.
public virtual string Vpc { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>