Interface Service.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Service.Builder,
,Service> SdkBuilder<Service.Builder,
,Service> SdkPojo
- Enclosing class:
Service
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.createDate
(Instant createDate) The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC).creatorRequestId
(String creatorRequestId) A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.description
(String description) The description of the service.default Service.Builder
dnsConfig
(Consumer<DnsConfig.Builder> dnsConfig) A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.default Service.Builder
healthCheckConfig
(Consumer<HealthCheckConfig.Builder> healthCheckConfig) Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.healthCheckConfig
(HealthCheckConfig healthCheckConfig) Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check.default Service.Builder
healthCheckCustomConfig
(Consumer<HealthCheckCustomConfig.Builder> healthCheckCustomConfig) A complex type that contains information about an optional custom health check.healthCheckCustomConfig
(HealthCheckCustomConfig healthCheckCustomConfig) A complex type that contains information about an optional custom health check.The ID that Cloud Map assigned to the service when you created it.instanceCount
(Integer instanceCount) The number of instances that are currently associated with the service.The name of the service.namespaceId
(String namespaceId) The ID of the namespace that was used to create the service.Describes the systems that can be used to discover the service instances.type
(ServiceType type) Describes the systems that can be used to discover the service instances.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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.
-
namespaceId
The ID of the namespace that was used to create the service.
- Parameters:
namespaceId
- The ID of the namespace that was used to create the service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the service.
- Parameters:
description
- The description of the service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
The record types of a service can only be changed by deleting the service and recreating it with a new
Dnsconfig
.- Parameters:
dnsConfig
- A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.The record types of a service can only be changed by deleting the service and recreating it with a new
Dnsconfig
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dnsConfig
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
The record types of a service can only be changed by deleting the service and recreating it with a new
Dnsconfig
.DnsConfig.Builder
avoiding the need to create one manually viaDnsConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todnsConfig(DnsConfig)
.- Parameters:
dnsConfig
- a consumer that will call methods onDnsConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
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:
-
healthCheckConfig
Public DNS and HTTP namespaces only. A complex type that contains 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
.For information about the charges for health checks, see Amazon Route 53 Pricing.
- Parameters:
healthCheckConfig
- Public DNS and HTTP namespaces only. A complex type that contains 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 inDnsConfig
.For information about the charges for health checks, see Amazon Route 53 Pricing.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckConfig
Public DNS and HTTP namespaces only. A complex type that contains 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
.For information about the charges for health checks, see Amazon Route 53 Pricing.
This is a convenience method that creates an instance of theHealthCheckConfig.Builder
avoiding the need to create one manually viaHealthCheckConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohealthCheckConfig(HealthCheckConfig)
.- Parameters:
healthCheckConfig
- a consumer that will call methods onHealthCheckConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
healthCheckCustomConfig
A complex type that contains information about an optional custom health check.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig
orHealthCheckConfig
but not both.- Parameters:
healthCheckCustomConfig
- A complex type that contains information about an optional custom health check.If you specify a health check configuration, you can specify either
HealthCheckCustomConfig
orHealthCheckConfig
but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthCheckCustomConfig
default Service.Builder healthCheckCustomConfig(Consumer<HealthCheckCustomConfig.Builder> healthCheckCustomConfig) A complex type that contains information about an optional custom health check.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig
orHealthCheckConfig
but not both.HealthCheckCustomConfig.Builder
avoiding the need to create one manually viaHealthCheckCustomConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohealthCheckCustomConfig(HealthCheckCustomConfig)
.- Parameters:
healthCheckCustomConfig
- a consumer that will call methods onHealthCheckCustomConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createDate
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of
CreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.- Parameters:
createDate
- The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value ofCreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creatorRequestId
A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.
CreatorRequestId
can be any unique string (for example, a date/timestamp).- Parameters:
creatorRequestId
- A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice.CreatorRequestId
can be any unique string (for example, a date/timestamp).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-