aws-cdk-lib.aws_servicediscovery.CnameInstanceProps

interface CnameInstanceProps

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

Example

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

declare const service: servicediscovery.Service;
const cnameInstanceProps: servicediscovery.CnameInstanceProps = {
  instanceCname: 'instanceCname',
  service: service,

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

Properties

NameTypeDescription
instanceCnamestringIf 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.
serviceIServiceThe Cloudmap service this resource is registered to.
customAttributes?{ [string]: string }Custom attributes of the instance.
instanceId?stringThe 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.