interface IInstance
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ServiceDiscovery.IInstance |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsservicediscovery#IInstance |
![]() | software.amazon.awscdk.services.servicediscovery.IInstance |
![]() | aws_cdk.aws_servicediscovery.IInstance |
![]() | aws-cdk-lib » aws_servicediscovery » IInstance |
Implemented by
Alias
, Cname
, Ip
, Non
Obtainable from
Service
.registerCnameInstance()
, Service
.registerIpInstance()
, Service
.registerLoadBalancer()
, Service
.registerNonIpInstance()
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
instance | string | The id of the instance resource. |
node | Node | The tree node. |
service | IService | The Cloudmap service this resource is registered to. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
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 resource.
node
Type:
Node
The tree node.
service
Type:
IService
The Cloudmap service this resource is registered to.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).