@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
date="2022-07-01T09:58:40.815Z")
public interface BaseServiceProps
Used by HttpNamespace.createService
Example:
import software.amazon.awscdk.core.*; import software.amazon.awscdk.services.servicediscovery.*; App app = new App(); Stack stack = new Stack(app, "aws-servicediscovery-integ"); HttpNamespace namespace = HttpNamespace.Builder.create(stack, "MyNamespace") .name("covfefe") .build(); Service service1 = namespace.createService("NonIpService", BaseServiceProps.builder() .description("service registering non-ip instances") .build()); service1.registerNonIpInstance("NonIpInstance", NonIpInstanceBaseProps.builder() .customAttributes(Map.of("arn", "arn:aws:s3:::mybucket")) .build()); Service service2 = namespace.createService("IpService", BaseServiceProps.builder() .description("service registering ip instances") .healthCheck(HealthCheckConfig.builder() .type(HealthCheckType.HTTP) .resourcePath("/check") .build()) .build()); service2.registerIpInstance("IpInstance", IpInstanceBaseProps.builder() .ipv4("54.239.25.192") .build()); app.synth();
Modifier and Type | Interface and Description |
---|---|
static class |
BaseServiceProps.Builder
A builder for
BaseServiceProps |
static class |
BaseServiceProps.Jsii$Proxy
An implementation for
BaseServiceProps |
Modifier and Type | Method and Description |
---|---|
static BaseServiceProps.Builder |
builder() |
default HealthCheckCustomConfig |
getCustomHealthCheck()
Structure containing failure threshold for a custom health checker.
|
default java.lang.String |
getDescription()
A description of the service.
|
default HealthCheckConfig |
getHealthCheck()
Settings for an optional health check.
|
default java.lang.String |
getName()
A name for the Service.
|
default HealthCheckCustomConfig getCustomHealthCheck()
Only one of healthCheckConfig or healthCheckCustomConfig can be specified. See: https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html
Default: none
default java.lang.String getDescription()
Default: none
default HealthCheckConfig getHealthCheck()
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
default java.lang.String getName()
Default: CloudFormation-generated name
static BaseServiceProps.Builder builder()
BaseServiceProps.Builder
of BaseServiceProps