aws-cdk-lib.aws_servicediscovery.InstanceBase

class InstanceBase

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

Implements IConstruct, IDependable, IResource, IInstance

Extends Resource

Implemented by AliasTargetInstance, CnameInstance, IpInstance, NonIpInstance

Initializer

new InstanceBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

  • scope Construct
  • id string
  • props ResourceProps

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
instanceIdstringThe Id of the instance.
nodeNodeThe tree node.
serviceIServiceThe Cloudmap service to which the instance is registered.
stackStackThe stack in which this resource is defined.

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.


instanceId

Type: string

The Id of the instance.


node

Type: Node

The tree node.


service

Type: IService

The Cloudmap service to which the instance is registered.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
protected uniqueInstanceId()Generate a unique instance Id that is safe to pass to CloudMap.

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).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected uniqueInstanceId()

protected uniqueInstanceId(): string

Returns

  • string

Generate a unique instance Id that is safe to pass to CloudMap.