software.amazon.awscdk.services.servicediscovery

Class Service.Builder

java.lang.Object

software.amazon.awscdk.services.servicediscovery.Service.Builder

Enclosing class:

Service

public static final class Service.Builder
extends java.lang.Object

A fluent builder for Service.

Method Summary

Modifier and Type	Method and Description
Service	build()
static Service.Builder	create(software.constructs.Construct scope, java.lang.String id)
Service.Builder	customHealthCheck(HealthCheckCustomConfig customHealthCheck) Structure containing failure threshold for a custom health checker.
Service.Builder	description(java.lang.String description) A description of the service.
Service.Builder	dnsRecordType(DnsRecordType dnsRecordType) The DNS type of the record that you want AWS Cloud Map to create.
Service.Builder	dnsTtl(Duration dnsTtl) The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Service.Builder	healthCheck(HealthCheckConfig healthCheck) Settings for an optional health check.
Service.Builder	loadBalancer(java.lang.Boolean loadBalancer) Whether or not this service will have an Elastic LoadBalancer registered to it as an AliasTargetInstance.
Service.Builder	name(java.lang.String name) A name for the Service.
Service.Builder	namespace(INamespace namespace) The namespace that you want to use for DNS configuration.
Service.Builder	routingPolicy(RoutingPolicy routingPolicy) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Service.Builder create(software.constructs.Construct scope,
                                     java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Service.Builder.

customHealthCheck

public Service.Builder customHealthCheck(HealthCheckCustomConfig customHealthCheck)

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

Parameters:

customHealthCheck - Structure containing failure threshold for a custom health checker. This parameter is required.

Returns:

this

description

public Service.Builder description(java.lang.String description)

A description of the service.

Default: none

Parameters:

description - A description of the service. This parameter is required.

Returns:

this

healthCheck

public Service.Builder healthCheck(HealthCheckConfig healthCheck)

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

Parameters:

healthCheck - Settings for an optional health check. This parameter is required.

Returns:

this

name

public Service.Builder name(java.lang.String name)

A name for the Service.

Default: CloudFormation-generated name

Parameters:

name - A name for the Service. This parameter is required.

Returns:

this

dnsRecordType

public Service.Builder dnsRecordType(DnsRecordType dnsRecordType)

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.

Default: A

Parameters:

dnsRecordType - The DNS type of the record that you want AWS Cloud Map to create. This parameter is required.

Returns:

this

dnsTtl

public Service.Builder dnsTtl(Duration dnsTtl)

The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

Default: Duration.minutes(1)

Parameters:

dnsTtl - The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record. This parameter is required.

Returns:

this

loadBalancer

public Service.Builder loadBalancer(java.lang.Boolean loadBalancer)

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.

Default: false

Parameters:

loadBalancer - Whether or not this service will have an Elastic LoadBalancer registered to it as an AliasTargetInstance. This parameter is required.

Returns:

this

routingPolicy

public Service.Builder routingPolicy(RoutingPolicy routingPolicy)

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

Parameters:

routingPolicy - 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. This parameter is required.

Returns:

this

namespace

public Service.Builder namespace(INamespace namespace)

The namespace that you want to use for DNS configuration.

Parameters:

namespace - The namespace that you want to use for DNS configuration. This parameter is required.

Returns:

this

build

public Service build()