AWS CDK Reference

Appearance

v2.274.0

BaseServiceProps Struct ​

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

Used by HttpNamespace.createService

Source
aws-servicediscovery/lib/service.ts

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.HttpNamespace(stack, 'MyNamespace', {
  name: 'MyHTTPNamespace',
});

const service1 = namespace.createService('NonIpService', {
  description: 'service registering non-ip instances',
});

service1.registerNonIpInstance('NonIpInstance', {
  customAttributes: { arn: 'arn:aws:s3:::amzn-s3-demo-bucket' },
});

const service2 = namespace.createService('IpService', {
  description: 'service registering ip instances',
  healthCheck: {
    type: servicediscovery.HealthCheckType.HTTP,
    resourcePath: '/check',
  },
});

service2.registerIpInstance('IpInstance', {
  ipv4: '54.239.25.192',
});

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

namestringnamestrnameStringNamestringName*string#
A name for the Service.

Default: CloudFormation-generated name