CfnPrivateDnsNamespacePropsMixin

class aws_cdk.mixins_preview.aws_servicediscovery.mixins.CfnPrivateDnsNamespacePropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-privatednsnamespace.html
CloudformationResource:: AWS::ServiceDiscovery::PrivateDnsNamespace
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_private_dns_namespace_props_mixin = servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin(servicediscovery_mixins.CfnPrivateDnsNamespaceMixinProps(
    description="description",
    name="name",
    properties=servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.PropertiesProperty(
        dns_properties=servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.PrivateDnsPropertiesMutableProperty(
            soa=servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.SOAProperty(
                ttl=123
            )
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc="vpc"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ServiceDiscovery::PrivateDnsNamespace.

Parameters:

props (Union[CfnPrivateDnsNamespaceMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'name', 'properties', 'tags', 'vpc']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

PrivateDnsPropertiesMutableProperty

class CfnPrivateDnsNamespacePropsMixin.PrivateDnsPropertiesMutableProperty(*, soa=None)

Bases: object

DNS properties for the private DNS namespace.

Parameters:: soa (Union[IResolvable, SOAProperty, Dict[str, Any], None]) – Fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-privatednspropertiesmutable.html
ExampleMetadata:: fixture=_generated

Example:

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

private_dns_properties_mutable_property = servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.PrivateDnsPropertiesMutableProperty(
    soa=servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.SOAProperty(
        ttl=123
    )
)

Attributes

soa

Fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.

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

PropertiesProperty

class CfnPrivateDnsNamespacePropsMixin.PropertiesProperty(*, dns_properties=None)

Bases: object

Properties for the private DNS namespace.

Parameters:: dns_properties (Union[IResolvable, PrivateDnsPropertiesMutableProperty, Dict[str, Any], None]) – DNS properties for the private DNS namespace.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-properties.html
ExampleMetadata:: fixture=_generated

Example:

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

properties_property = servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.PropertiesProperty(
    dns_properties=servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.PrivateDnsPropertiesMutableProperty(
        soa=servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.SOAProperty(
            ttl=123
        )
    )
)

Attributes

dns_properties

DNS properties for the private DNS namespace.

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

SOAProperty

class CfnPrivateDnsNamespacePropsMixin.SOAProperty(*, ttl=None)

Bases: object

Start of Authority (SOA) properties for a public or private DNS namespace.

Parameters:: ttl (Union[int, float, None]) – The time to live (TTL) for purposes of negative caching.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-privatednsnamespace-soa.html
ExampleMetadata:: fixture=_generated

Example:

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

s_oAProperty = servicediscovery_mixins.CfnPrivateDnsNamespacePropsMixin.SOAProperty(
    ttl=123
)

Attributes

ttl

The time to live (TTL) for purposes of negative caching.

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