AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

CnameInstance

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

Import

import { CnameInstance } from 'aws-cdk-lib/aws-servicediscovery';

Or use the module namespace:

import * as servicediscovery from 'aws-cdk-lib/aws-servicediscovery';
// servicediscovery.CnameInstance

Properties

Configuration passed to the constructor as CnameInstanceProps.

serviceRequired
IService

The Cloudmap service this resource is registered to.

1 property inherited from CnameInstanceBaseProps
instanceCnameRequiredinherited from CnameInstanceBaseProps
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.

2 properties inherited from BaseInstanceProps
customAttributesOptionalinherited from BaseInstanceProps
{ [key: string]: string }

Custom attributes of the instance.

Default: none

instanceIdOptionalinherited from BaseInstanceProps
string

The id of the instance resource.

Default: Automatically generated name

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL2 (Higher-level)
Moduleaws-servicediscovery
Properties4

Related Constructs

Explore This Service

External Links