aws-cdk-lib.aws_servicediscovery.INamespace

interface INamespace

LanguageType name
.NETAmazon.CDK.AWS.ServiceDiscovery.INamespace
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsservicediscovery#INamespace
Javasoftware.amazon.awscdk.services.servicediscovery.INamespace
Pythonaws_cdk.aws_servicediscovery.INamespace
TypeScript (source)aws-cdk-lib » aws_servicediscovery » INamespace

Implemented by HttpNamespace, PrivateDnsNamespace, PublicDnsNamespace

Obtainable from Cluster.addDefaultCloudMapNamespace()

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
namespaceArnstringNamespace ARN for the Namespace.
namespaceIdstringNamespace Id for the Namespace.
namespaceNamestringA name for the Namespace.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
typeNamespaceTypeType of Namespace.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


namespaceArn

Type: string

Namespace ARN for the Namespace.


namespaceId

Type: string

Namespace Id for the Namespace.


namespaceName

Type: string

A name for the Namespace.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


type

Type: NamespaceType

Type of Namespace.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).