interface IService
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ServiceDiscovery.IService |
Java | software.amazon.awscdk.services.servicediscovery.IService |
Python | aws_cdk.aws_servicediscovery.IService |
TypeScript (source) | @aws-cdk/aws-servicediscovery » IService |
Implemented by
Service
Obtainable from
Service
.fromServiceAttributes()
Properties
Name | Type | Description |
---|---|---|
dns | Dns | The DnsRecordType used by the service. |
env | Resource | The environment this resource belongs to. |
namespace | INamespace | The namespace for the Cloudmap Service. |
node | Construct | The construct tree node for this construct. |
routing | Routing | The Routing Policy used by the service. |
service | string | The Arn of the namespace that you want to use for DNS configuration. |
service | string | The ID of the namespace that you want to use for DNS configuration. |
service | string | A name for the Cloudmap Service. |
stack | Stack | The stack in which this resource is defined. |
dnsRecordType
Type:
Dns
The DnsRecordType used by the service.
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.
namespace
Type:
INamespace
The namespace for the Cloudmap Service.
node
Type:
Construct
The construct tree node for this construct.
routingPolicy
Type:
Routing
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
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
).