Skip to content

Namespace

Source code in docs_src/capo_servicediscovery/types/namespace.py
class Namespace(TypedDict, closed=True):
    id: NotRequired["capo_servicediscovery.types.resource_id.ResourceId"]
    """<p>The ID of a namespace.</p>"""
    arn: NotRequired["capo_servicediscovery.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.</p>"""
    resource_owner: NotRequired[
        "capo_servicediscovery.types.aws_account_id.AWSAccountId"
    ]
    """<p>The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>"""
    name: NotRequired["capo_servicediscovery.types.namespace_name.NamespaceName"]
    """<p>The name of the namespace, such as <code>example.com</code>.</p>"""
    type: NotRequired["capo_servicediscovery.types.namespace_type.NamespaceType"]
    """<p>The type of the namespace. The methods for discovering instances depends on the value that you specify:</p> <dl> <dt>HTTP</dt> <dd> <p>Instances can be discovered only programmatically, using the Cloud Map <code>DiscoverInstances</code> API.</p> </dd> <dt>DNS_PUBLIC</dt> <dd> <p>Instances can be discovered using public DNS queries and using the <code>DiscoverInstances</code> API.</p> </dd> <dt>DNS_PRIVATE</dt> <dd> <p>Instances can be discovered using DNS queries in VPCs and using the <code>DiscoverInstances</code> API.</p> </dd> </dl>"""
    description: NotRequired[
        "capo_servicediscovery.types.resource_description.ResourceDescription"
    ]
    """<p>The description that you specify for the namespace when you create it.</p>"""
    service_count: NotRequired[
        "capo_servicediscovery.types.resource_count.ResourceCount"
    ]
    """<p>The number of services that are associated with the namespace.</p>"""
    properties: NotRequired[
        "capo_servicediscovery.types.namespace_properties.NamespaceProperties"
    ]
    """<p>A complex type that contains information that's specific to the type of the namespace.</p>"""
    create_date: NotRequired["capo_servicediscovery.types.timestamp.Timestamp"]
    """<p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    creator_request_id: NotRequired[
        "capo_servicediscovery.types.resource_id.ResourceId"
    ]
    """<p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice. </p>"""

arn instance-attribute

arn: NotRequired[Arn]

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

create_date instance-attribute

create_date: NotRequired[Timestamp]

The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

creator_request_id instance-attribute

creator_request_id: NotRequired[ResourceId]

A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.

description instance-attribute

description: NotRequired[ResourceDescription]

The description that you specify for the namespace when you create it.

id instance-attribute

id: NotRequired[ResourceId]

The ID of a namespace.

name instance-attribute

name: NotRequired[NamespaceName]

The name of the namespace, such as example.com.

properties instance-attribute

properties: NotRequired[NamespaceProperties]

A complex type that contains information that's specific to the type of the namespace.

resource_owner instance-attribute

resource_owner: NotRequired[AWSAccountId]

The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's the ID of the account that shared the namespace with your account. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

service_count instance-attribute

service_count: NotRequired[ResourceCount]

The number of services that are associated with the namespace.

type instance-attribute

type: NotRequired[NamespaceType]

The type of the namespace. The methods for discovering instances depends on the value that you specify:

HTTP

Instances can be discovered only programmatically, using the Cloud Map DiscoverInstances API.

DNS_PUBLIC

Instances can be discovered using public DNS queries and using the DiscoverInstances API.

DNS_PRIVATE

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.