aws-cdk-lib.aws_servicediscovery.IService

interface IService

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

Implemented by Service

Obtainable from Service.fromServiceAttributes()

Properties

NameTypeDescription
discoveryTypeDiscoveryTypeThe discovery type used by the service.
dnsRecordTypeDnsRecordTypeThe DnsRecordType used by the service.
envResourceEnvironmentThe environment this resource belongs to.
namespaceINamespaceThe namespace for the Cloudmap Service.
nodeNodeThe tree node.
routingPolicyRoutingPolicyThe Routing Policy used by the service.
serviceArnstringThe Arn of the namespace that you want to use for DNS configuration.
serviceIdstringThe ID of the namespace that you want to use for DNS configuration.
serviceNamestringA name for the Cloudmap Service.
stackStackThe stack in which this resource is defined.

discoveryType

Type: DiscoveryType

The discovery type used by the service.


dnsRecordType

Type: DnsRecordType

The DnsRecordType used by the service.


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.


namespace

Type: INamespace

The namespace for the Cloudmap Service.


node

Type: Node

The tree node.


routingPolicy

Type: RoutingPolicy

The Routing Policy used by the service.


serviceArn

Type: string

The Arn of the namespace that you want to use for DNS configuration.


serviceId

Type: string

The ID of the namespace that you want to use for DNS configuration.


serviceName

Type: string

A name for the Cloudmap Service.


stack

Type: Stack

The stack in which this resource is defined.

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