AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ServiceChange

import "github.com/aws/aws-sdk-go/service/servicediscovery"

type ServiceChange struct { Description *string `type:"string"` DnsConfig *DnsConfigChange `type:"structure" required:"true"` HealthCheckConfig *HealthCheckConfig `type:"structure"` }

A complex type that contains changes to an existing service.

Description

Type: *string

A description for the service.

DnsConfig

A complex type that contains information about changes to the Route 53 DNS records that AWS Cloud Map creates when you register an instance.

HealthCheckConfig

Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

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

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing (https://aws.amazon.com/route53/pricing/).

Note the following about configuring health checks.

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

CNAME records

You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

Request interval

A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.

Health checking regions

Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions).

Alias records

When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:

  • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

Charges for health checks

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing (https://aws.amazon.com/route53/pricing/).

Method

GoString

func (s ServiceChange) GoString() string

GoString returns the string representation

SetDescription

func (s *ServiceChange) SetDescription(v string) *ServiceChange

SetDescription sets the Description field's value.

SetDnsConfig

func (s *ServiceChange) SetDnsConfig(v *DnsConfigChange) *ServiceChange

SetDnsConfig sets the DnsConfig field's value.

SetHealthCheckConfig

func (s *ServiceChange) SetHealthCheckConfig(v *HealthCheckConfig) *ServiceChange

SetHealthCheckConfig sets the HealthCheckConfig field's value.

String

func (s ServiceChange) String() string

String returns the string representation

Validate

func (s *ServiceChange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: