class CnameInstance (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ServiceDiscovery.CnameInstance
Java	software.amazon.awscdk.services.servicediscovery.CnameInstance
Python	aws_cdk.aws_servicediscovery.CnameInstance
TypeScript (source)	@aws-cdk/aws-servicediscovery » CnameInstance

Implements IConstruct, IConstruct, IDependable, IResource, IInstance

Instance that is accessible using a domain name (CNAME).

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as servicediscovery from '@aws-cdk/aws-servicediscovery';

declare const service: servicediscovery.Service;
const cnameInstance = new servicediscovery.CnameInstance(this, 'MyCnameInstance', {
  instanceCname: 'instanceCname',
  service: service,

  // the properties below are optional
  customAttributes: {
    customAttributesKey: 'customAttributes',
  },
  instanceId: 'instanceId',
});

Initializer

new CnameInstance(scope: Construct, id: string, props: CnameInstanceProps)

Parameters

• scope Construct
• id string
• props CnameInstanceProps

Construct Props

Name	Type	Description
instanceCname	string	If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. This value is required if the service specified by ServiceId includes settings for an CNAME record.
service	IService	The Cloudmap service this resource is registered to.
customAttributes?	{ [string]: string }	Custom attributes of the instance.
instanceId?	string	The id of the instance resource.

---

instanceCname

Type: string

If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com. This value is required if the service specified by ServiceId includes settings for an CNAME record.

---

service

Type: IService

The Cloudmap service this resource is registered to.

---

customAttributes?

Type: { [string]: string } (optional, default: none)

Custom attributes of the instance.

---

instanceId?

Type: string (optional, default: Automatically generated name)

The id of the instance resource.

Properties

Name	Type	Description
cname	string	The domain name returned by DNS queries for the instance.
env	ResourceEnvironment	The environment this resource belongs to.
instanceId	string	The Id of the instance.
node	ConstructNode	The construct tree node associated with this construct.
service	IService	The Cloudmap service to which the instance is registered.
stack	Stack	The stack in which this resource is defined.

---

cname

Type: string

The domain name returned by DNS queries for the instance.

---

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: ConstructNode

The construct tree node associated with this construct.

---

service

Type: IService

The Cloudmap service to which the instance is registered.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

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.