CloudMapNamespaceOptions

class aws_cdk.aws_ecs.CloudMapNamespaceOptions(*, name, type=None, vpc=None)

Bases: object

The options for creating an AWS Cloud Map namespace.

Parameters
  • name (str) – The name of the namespace, such as example.com.

  • type (Optional[NamespaceType]) – The type of CloudMap Namespace to create. Default: PrivateDns

  • vpc (Optional[IVpc]) – The VPC to associate the namespace with. This property is required for private DNS namespaces. Default: VPC of the cluster for Private DNS Namespace, otherwise none

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_ec2 as ec2
import aws_cdk.aws_ecs as ecs
import aws_cdk.aws_servicediscovery as servicediscovery

# vpc is of type Vpc

cloud_map_namespace_options = ecs.CloudMapNamespaceOptions(
    name="name",

    # the properties below are optional
    type=servicediscovery.NamespaceType.HTTP,
    vpc=vpc
)

Attributes

name

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

Return type

str

type

The type of CloudMap Namespace to create.

Default

PrivateDns

Return type

Optional[NamespaceType]

vpc

The VPC to associate the namespace with.

This property is required for private DNS namespaces.

Default

VPC of the cluster for Private DNS Namespace, otherwise none

Return type

Optional[IVpc]