AWS CDK Reference

Appearance

v2.274.0

ServiceProps Struct ​

Source
aws-servicediscovery/lib/service.ts

Example ​

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

declare const namespace: servicediscovery.INamespace;
const serviceProps: servicediscovery.ServiceProps = {
  namespace: namespace,

  // the properties below are optional
  customHealthCheck: {
    failureThreshold: 123,
  },
  description: 'description',
  discoveryType: servicediscovery.DiscoveryType.API,
  dnsRecordType: servicediscovery.DnsRecordType.A,
  dnsTtl: cdk.Duration.minutes(30),
  healthCheck: {
    failureThreshold: 123,
    resourcePath: 'resourcePath',
    type: servicediscovery.HealthCheckType.HTTP,
  },
  loadBalancer: false,
  name: 'name',
  routingPolicy: servicediscovery.RoutingPolicy.WEIGHTED,
};

Properties ​

customHealthCheckoptionalHealthCheckCustomConfigcustom_health_checkoptionalHealthCheckCustomConfigcustomHealthCheckoptionalHealthCheckCustomConfigCustomHealthCheckoptionalHealthCheckCustomConfigCustomHealthCheckoptionalHealthCheckCustomConfig= 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

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= none#
A description of the service.
discoveryTypeoptionalDiscoveryTypediscovery_typeoptionalDiscoveryTypediscoveryTypeoptionalDiscoveryTypeDiscoveryTypeoptionalDiscoveryTypeDiscoveryTypeoptionalDiscoveryType= DNS_AND_API#
Controls how instances within this service can be discovered.
dnsRecordTypeoptionalDnsRecordTypedns_record_typeoptionalDnsRecordTypednsRecordTypeoptionalDnsRecordTypeDnsRecordTypeoptionalDnsRecordTypeDnsRecordTypeoptionalDnsRecordType= 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.

dnsTtloptionalDurationdns_ttloptionalDurationdnsTtloptionalDurationDnsTtloptionalDurationDnsTtloptionalDuration= Duration.minutes(1)#
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
healthCheckoptionalHealthCheckConfighealth_checkoptionalHealthCheckConfighealthCheckoptionalHealthCheckConfigHealthCheckoptionalHealthCheckConfigHealthCheckoptionalHealthCheckConfig= 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.

loadBalanceroptionalbooleanload_balanceroptionalboolloadBalanceroptionalBooleanLoadBalanceroptionalboolLoadBalanceroptional*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.

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
A name for the Service.

Default: CloudFormation-generated name

namespaceINamespacenamespaceINamespacenamespaceINamespaceNamespaceINamespaceNamespaceINamespacerequired#
The namespace that you want to use for DNS configuration.
routingPolicyoptionalRoutingPolicyrouting_policyoptionalRoutingPolicyroutingPolicyoptionalRoutingPolicyRoutingPolicyoptionalRoutingPolicyRoutingPolicyoptionalRoutingPolicy#
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: WEIGHTED for CNAME records and when loadBalancer is true, MULTIVALUE otherwise