AWS CDK Reference

Appearance

v2.273.0

DnsServiceProps Struct ​

Service props needed to create a service in a given namespace.

Used by createService() for PrivateDnsNamespace and PublicDnsNamespace

Source
aws-servicediscovery/lib/service.ts
Type last changed
v2.38.0 · 17 Aug 2022

Example ​

ts
import * as cdk from '../../core';
import * as servicediscovery from '../lib';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'aws-servicediscovery-integ');

const namespace = new servicediscovery.PublicDnsNamespace(stack, 'Namespace', {
  name: 'foobar.com',
});

const service = namespace.createService('Service', {
  name: 'foo',
  dnsRecordType: servicediscovery.DnsRecordType.A,
  dnsTtl: cdk.Duration.seconds(30),
  healthCheck: {
    type: servicediscovery.HealthCheckType.HTTPS,
    resourcePath: '/healthcheck',
    failureThreshold: 2,
  },
});

service.registerIpInstance('IpInstance', {
  ipv4: '54.239.25.192',
  port: 443,
});

app.synth();

Properties ​

customHealthCheckHealthCheckCustomConfigcustom_health_checkHealthCheckCustomConfigcustomHealthCheckHealthCheckCustomConfigCustomHealthCheckHealthCheckCustomConfigCustomHealthCheckHealthCheckCustomConfig= none#
Structure containing failure threshold for a custom health checker.

Only one of healthCheckConfig or healthCheckCustomConfig can be specified. See: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= none#
A description of the service.
discoveryTypeDiscoveryTypediscovery_typeDiscoveryTypediscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryTypeDiscoveryType= DNS_AND_API#
Controls how instances within this service can be discovered.
dnsRecordTypeDnsRecordTypedns_record_typeDnsRecordTypednsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordTypeDnsRecordType= A#
The DNS type of the record that you want AWS Cloud Map to create.

Supported record types include A, AAAA, A and AAAA (A_AAAA), CNAME, and SRV.

dnsTtlDurationdns_ttlDurationdnsTtlDurationDnsTtlDurationDnsTtlDuration= Duration.minutes(1)#
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
healthCheckHealthCheckConfighealth_checkHealthCheckConfighealthCheckHealthCheckConfigHealthCheckHealthCheckConfigHealthCheckHealthCheckConfig= none#
Settings for an optional health check.
notes

If you specify health check settings, AWS Cloud Map associates the health check with the records that you specify in DnsConfig. Only one of healthCheckConfig or healthCheckCustomConfig can be specified. Not valid for PrivateDnsNamespaces. If you use healthCheck, you can only register IP instances to this service.

loadBalancerbooleanload_balancerboolloadBalancerBooleanLoadBalancerboolLoadBalancer*bool= false#
Whether or not this service will have an Elastic LoadBalancer registered to it as an AliasTargetInstance.

Setting this to true correctly configures the routingPolicy and performs some additional validation.

namestringnamestrnameStringNamestringName*string= CloudFormation-generated name#
A name for the Service.
routingPolicyRoutingPolicyrouting_policyRoutingPolicyroutingPolicyRoutingPolicyRoutingPolicyRoutingPolicyRoutingPolicyRoutingPolicy= WEIGHTED for CNAME records and w…#
The routing policy that you want to apply to all DNS records that AWS Cloud Map creates when you register an instance and specify this service.
default

Default: WEIGHTED for CNAME records and when loadBalancer is true, MULTIVALUE otherwise