BaseServiceProps¶

class aws_cdk.aws_servicediscovery.BaseServiceProps(*, custom_health_check=None, description=None, health_check=None, name=None)¶

Bases: object

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

Used by HttpNamespace.createService

Parameters

custom_health_check (Optional[HealthCheckCustomConfig]) – 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 Default: none
description (Optional[str]) – A description of the service. Default: none
health_check (Optional[HealthCheckConfig]) – Settings for an optional health check. 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. Default: none
name (Optional[str]) – A name for the Service. Default: CloudFormation-generated name

Attributes

custom_health_check¶

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

Default: none
Return type: Optional[HealthCheckCustomConfig]

description¶

A description of the service.

Default: none
Return type: Optional[str]

health_check¶

Settings for an optional health check.

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.

Default: none
Return type: Optional[HealthCheckConfig]

name¶

A name for the Service.

Default: CloudFormation-generated name
Return type: Optional[str]