AWS CDK Reference

Appearance

v2.274.0

CfnServiceProps Struct ​

Properties for defining a CfnService.

Source
Generated code
Type last changed
v2.264.0 · 10 Aug 2026

Example ​

ts
// 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';
const cfnServiceProps: servicediscovery.CfnServiceProps = {
  description: 'description',
  dnsConfig: {
    dnsRecords: [{
      ttl: 123,
      type: 'type',
    }],

    // the properties below are optional
    namespaceId: 'namespaceId',
    routingPolicy: 'routingPolicy',
  },
  healthCheckConfig: {
    type: 'type',

    // the properties below are optional
    failureThreshold: 123,
    resourcePath: 'resourcePath',
  },
  healthCheckCustomConfig: {
    failureThreshold: 123,
  },
  name: 'name',
  namespaceId: 'namespaceId',
  serviceAttributes: {
    serviceAttributesKey: 'serviceAttributes',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the service.
dnsConfigoptionalIResolvable | CfnService.DnsConfigPropertydns_configoptionaltyping.Union[IResolvable, DnsConfigProperty]dnsConfigoptionalIResolvableDnsConfigoptionalIResolvableDnsConfigoptionalinterface{}#
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig .

healthCheckConfigoptionalIResolvable | CfnService.HealthCheckConfigPropertyhealth_check_configoptionaltyping.Union[IResolvable, HealthCheckConfigProperty]healthCheckConfigoptionalIResolvableHealthCheckConfigoptionalIResolvableHealthCheckConfigoptionalinterface{}#
*Public DNS and HTTP namespaces only.* A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in `DnsConfig` .

For information about the charges for health checks, see Amazon Route 53 Pricing .

healthCheckCustomConfigoptionalIResolvable | CfnService.HealthCheckCustomConfigPropertyhealth_check_custom_configoptionaltyping.Union[IResolvable, HealthCheckCustomConfigProperty]healthCheckCustomConfigoptionalIResolvableHealthCheckCustomConfigoptionalIResolvableHealthCheckCustomConfigoptionalinterface{}#
A complex type that contains information about an optional custom health check.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the service.
namespaceIdoptionalstringnamespace_idoptionalstrnamespaceIdoptionalStringNamespaceIdoptionalstringNamespaceIdoptional*string#
The ID or Amazon Resource Name (ARN) of the namespace that you want to use to create the service.
notes

For namespaces shared with your AWS account, specify the namespace ARN. For more information about shared namespaces, see Cross-account AWS Cloud Map namespace sharing in the AWS Cloud Map Developer Guide .

serviceAttributesoptionalIResolvable | { [key: string]: string }service_attributesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]serviceAttributesoptionalIResolvableServiceAttributesoptionalIResolvableServiceAttributesoptionalinterface{}#
A complex type that contains information about attributes associated with a specific service.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags for the service.

Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

typeoptionalstringtypeoptionalstrtypeoptionalStringTypeoptionalstringTypeoptional*string#
If present, specifies that the service instances are only discoverable using the `DiscoverInstances` API operation.

No DNS records is registered for the service instances. The only valid value is HTTP .