software.amazon.awssdk.services.servicediscovery.model

Interface ServiceSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ServiceSummary.Builder,ServiceSummary>, SdkBuilder<ServiceSummary.Builder,ServiceSummary>, SdkPojo

Enclosing class:

ServiceSummary

public static interface ServiceSummary.Builder
extends SdkPojo, CopyableBuilder<ServiceSummary.Builder,ServiceSummary>

Method Summary

Modifier and Type	Method and Description
ServiceSummary.Builder	arn(String arn) The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
ServiceSummary.Builder	createDate(Instant createDate) The date and time that the service was created.
ServiceSummary.Builder	description(String description) The description that you specify when you create the service.
default ServiceSummary.Builder	dnsConfig(Consumer<DnsConfig.Builder> dnsConfig) Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
ServiceSummary.Builder	dnsConfig(DnsConfig dnsConfig) Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
default ServiceSummary.Builder	healthCheckConfig(Consumer<HealthCheckConfig.Builder> healthCheckConfig) Public DNS and HTTP namespaces only. Settings for an optional health check.
ServiceSummary.Builder	healthCheckConfig(HealthCheckConfig healthCheckConfig) Public DNS and HTTP namespaces only. Settings for an optional health check.
default ServiceSummary.Builder	healthCheckCustomConfig(Consumer<HealthCheckCustomConfig.Builder> healthCheckCustomConfig) Information about an optional custom health check.
ServiceSummary.Builder	healthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig) Information about an optional custom health check.
ServiceSummary.Builder	id(String id) The ID that Cloud Map assigned to the service when you created it.
ServiceSummary.Builder	instanceCount(Integer instanceCount) The number of instances that are currently associated with the service.
ServiceSummary.Builder	name(String name) The name of the service.
ServiceSummary.Builder	type(ServiceType type) Describes the systems that can be used to discover the service instances.
ServiceSummary.Builder	type(String type) Describes the systems that can be used to discover the service instances.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

id

ServiceSummary.Builder id(String id)

The ID that Cloud Map assigned to the service when you created it.

Parameters:

id - The ID that Cloud Map assigned to the service when you created it.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

ServiceSummary.Builder arn(String arn)

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

Parameters:

arn - The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

ServiceSummary.Builder name(String name)

The name of the service.

Parameters:

name - The name of the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

ServiceSummary.Builder type(String type)

Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

Parameters:

type - Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceType, ServiceType

type

ServiceSummary.Builder type(ServiceType type)

Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

Parameters:

type - Describes the systems that can be used to discover the service instances.

DNS_HTTP

The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceType, ServiceType

description

ServiceSummary.Builder description(String description)

The description that you specify when you create the service.

Parameters:

description - The description that you specify when you create the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceCount

ServiceSummary.Builder instanceCount(Integer instanceCount)

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

Parameters:

instanceCount - The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

Returns:

Returns a reference to this object so that method calls can be chained together.

dnsConfig

ServiceSummary.Builder dnsConfig(DnsConfig dnsConfig)

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

Parameters:

dnsConfig - Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

dnsConfig

default ServiceSummary.Builder dnsConfig(Consumer<DnsConfig.Builder> dnsConfig)

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

This is a convenience method that creates an instance of the DnsConfig.Builder avoiding the need to create one manually via DnsConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dnsConfig(DnsConfig).

Parameters:

dnsConfig - a consumer that will call methods on DnsConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

dnsConfig(DnsConfig)

healthCheckConfig

ServiceSummary.Builder healthCheckConfig(HealthCheckConfig healthCheckConfig)

Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

Parameters:

healthCheckConfig - Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

Returns:

Returns a reference to this object so that method calls can be chained together.

healthCheckConfig

default ServiceSummary.Builder healthCheckConfig(Consumer<HealthCheckConfig.Builder> healthCheckConfig)

Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, Cloud Map associates the health check with the records that you specify in DnsConfig.

This is a convenience method that creates an instance of the HealthCheckConfig.Builder avoiding the need to create one manually via HealthCheckConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthCheckConfig(HealthCheckConfig).

Parameters:

healthCheckConfig - a consumer that will call methods on HealthCheckConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

healthCheckConfig(HealthCheckConfig)

healthCheckCustomConfig

ServiceSummary.Builder healthCheckCustomConfig(HealthCheckCustomConfig healthCheckCustomConfig)

Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

• You can't use a health check that's defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

• You want to use a third-party health checker regardless of where your resources are located.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

Parameters:

healthCheckCustomConfig - Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

• You can't use a health check that's defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

• You want to use a third-party health checker regardless of where your resources are located.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

healthCheckCustomConfig

default ServiceSummary.Builder healthCheckCustomConfig(Consumer<HealthCheckCustomConfig.Builder> healthCheckCustomConfig)

Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

• You can't use a health check that's defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

• You want to use a third-party health checker regardless of where your resources are located.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

This is a convenience method that creates an instance of the HealthCheckCustomConfig.Builder avoiding the need to create one manually via HealthCheckCustomConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthCheckCustomConfig(HealthCheckCustomConfig).

Parameters:

healthCheckCustomConfig - a consumer that will call methods on HealthCheckCustomConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

healthCheckCustomConfig(HealthCheckCustomConfig)

createDate

ServiceSummary.Builder createDate(Instant createDate)

The date and time that the service was created.

Parameters:

createDate - The date and time that the service was created.

Returns:

Returns a reference to this object so that method calls can be chained together.