CfnPrivateDnsNamespaceProps

class aws_cdk.aws_servicediscovery.CfnPrivateDnsNamespaceProps(*, name, vpc, description=None, properties=None, tags=None)

Bases: object

Properties for defining a CfnPrivateDnsNamespace.

Parameters
  • name (str) – 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.

  • vpc (str) – The ID of the Amazon VPC that you want to associate the namespace with.

  • description (Optional[str]) – A description for the namespace.

  • properties (Union[IResolvable, PropertiesProperty, Dict[str, Any], None]) – Properties for the private DNS namespace.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_servicediscovery as servicediscovery

cfn_private_dns_namespace_props = servicediscovery.CfnPrivateDnsNamespaceProps(
    name="name",
    vpc="vpc",

    # the properties below are optional
    description="description",
    properties=servicediscovery.CfnPrivateDnsNamespace.PropertiesProperty(
        dns_properties=servicediscovery.CfnPrivateDnsNamespace.PrivateDnsPropertiesMutableProperty(
            soa=servicediscovery.CfnPrivateDnsNamespace.SOAProperty(
                ttl=123
            )
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description for the namespace.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-description

Return type

Optional[str]

name

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-name

Return type

str

properties

Properties for the private DNS namespace.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-properties

Return type

Union[IResolvable, PropertiesProperty, None]

tags

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-tags

Return type

Optional[List[CfnTag]]

vpc

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html#cfn-servicediscovery-privatednsnamespace-vpc

Return type

str