package types
import "github.com/aws/aws-sdk-go-v2/service/servicediscovery/types"
Index ¶
- type CustomHealthNotFound
- func (e *CustomHealthNotFound) Error() string
- func (e *CustomHealthNotFound) ErrorCode() string
- func (e *CustomHealthNotFound) ErrorFault() smithy.ErrorFault
- func (e *CustomHealthNotFound) ErrorMessage() string
- type CustomHealthStatus
- type DnsConfig
- type DnsConfigChange
- type DnsProperties
- type DnsRecord
- type DuplicateRequest
- func (e *DuplicateRequest) Error() string
- func (e *DuplicateRequest) ErrorCode() string
- func (e *DuplicateRequest) ErrorFault() smithy.ErrorFault
- func (e *DuplicateRequest) ErrorMessage() string
- type FilterCondition
- type HealthCheckConfig
- type HealthCheckCustomConfig
- type HealthCheckType
- type HealthStatus
- type HealthStatusFilter
- type HttpInstanceSummary
- type HttpProperties
- type Instance
- type InstanceNotFound
- func (e *InstanceNotFound) Error() string
- func (e *InstanceNotFound) ErrorCode() string
- func (e *InstanceNotFound) ErrorFault() smithy.ErrorFault
- func (e *InstanceNotFound) ErrorMessage() string
- type InstanceSummary
- type InvalidInput
- func (e *InvalidInput) Error() string
- func (e *InvalidInput) ErrorCode() string
- func (e *InvalidInput) ErrorFault() smithy.ErrorFault
- func (e *InvalidInput) ErrorMessage() string
- type Namespace
- type NamespaceAlreadyExists
- func (e *NamespaceAlreadyExists) Error() string
- func (e *NamespaceAlreadyExists) ErrorCode() string
- func (e *NamespaceAlreadyExists) ErrorFault() smithy.ErrorFault
- func (e *NamespaceAlreadyExists) ErrorMessage() string
- type NamespaceFilter
- type NamespaceFilterName
- type NamespaceNotFound
- func (e *NamespaceNotFound) Error() string
- func (e *NamespaceNotFound) ErrorCode() string
- func (e *NamespaceNotFound) ErrorFault() smithy.ErrorFault
- func (e *NamespaceNotFound) ErrorMessage() string
- type NamespaceProperties
- type NamespaceSummary
- type NamespaceType
- type Operation
- type OperationFilter
- type OperationFilterName
- type OperationNotFound
- func (e *OperationNotFound) Error() string
- func (e *OperationNotFound) ErrorCode() string
- func (e *OperationNotFound) ErrorFault() smithy.ErrorFault
- func (e *OperationNotFound) ErrorMessage() string
- type OperationStatus
- type OperationSummary
- type OperationTargetType
- type OperationType
- type RecordType
- type RequestLimitExceeded
- func (e *RequestLimitExceeded) Error() string
- func (e *RequestLimitExceeded) ErrorCode() string
- func (e *RequestLimitExceeded) ErrorFault() smithy.ErrorFault
- func (e *RequestLimitExceeded) ErrorMessage() string
- type ResourceInUse
- func (e *ResourceInUse) Error() string
- func (e *ResourceInUse) ErrorCode() string
- func (e *ResourceInUse) ErrorFault() smithy.ErrorFault
- func (e *ResourceInUse) ErrorMessage() string
- type ResourceLimitExceeded
- func (e *ResourceLimitExceeded) Error() string
- func (e *ResourceLimitExceeded) ErrorCode() string
- func (e *ResourceLimitExceeded) ErrorFault() smithy.ErrorFault
- func (e *ResourceLimitExceeded) ErrorMessage() string
- type ResourceNotFoundException
- func (e *ResourceNotFoundException) Error() string
- func (e *ResourceNotFoundException) ErrorCode() string
- func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *ResourceNotFoundException) ErrorMessage() string
- type RoutingPolicy
- type Service
- type ServiceAlreadyExists
- func (e *ServiceAlreadyExists) Error() string
- func (e *ServiceAlreadyExists) ErrorCode() string
- func (e *ServiceAlreadyExists) ErrorFault() smithy.ErrorFault
- func (e *ServiceAlreadyExists) ErrorMessage() string
- type ServiceChange
- type ServiceFilter
- type ServiceFilterName
- type ServiceNotFound
- func (e *ServiceNotFound) Error() string
- func (e *ServiceNotFound) ErrorCode() string
- func (e *ServiceNotFound) ErrorFault() smithy.ErrorFault
- func (e *ServiceNotFound) ErrorMessage() string
- type ServiceSummary
- type ServiceType
- type ServiceTypeOption
- type Tag
- type TooManyTagsException
Types ¶
type CustomHealthNotFound ¶
type CustomHealthNotFound struct { Message *string }
The health check for the instance that is specified by ServiceId and InstanceId is not a custom health check.
func (*CustomHealthNotFound) Error ¶
func (e *CustomHealthNotFound) Error() string
func (*CustomHealthNotFound) ErrorCode ¶
func (e *CustomHealthNotFound) ErrorCode() string
func (*CustomHealthNotFound) ErrorFault ¶
func (e *CustomHealthNotFound) ErrorFault() smithy.ErrorFault
func (*CustomHealthNotFound) ErrorMessage ¶
func (e *CustomHealthNotFound) ErrorMessage() string
type CustomHealthStatus ¶
type CustomHealthStatus string
const ( CustomHealthStatusHealthy CustomHealthStatus = "HEALTHY" CustomHealthStatusUnhealthy CustomHealthStatus = "UNHEALTHY" )
Enum values for CustomHealthStatus
func (CustomHealthStatus) Values ¶
func (CustomHealthStatus) Values() []CustomHealthStatus
Values returns all known values for CustomHealthStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type DnsConfig ¶
type DnsConfig struct { // An array that contains one DnsRecord object for each Route 53 DNS record that // you want AWS Cloud Map to create when you register an instance. // // This member is required. DnsRecords []DnsRecord // The ID of the namespace to use for DNS configuration. // // Deprecated: Top level attribute in request should be used to reference // namespace-id NamespaceId *string // The routing policy that you want to apply to all Route 53 DNS records that AWS // Cloud Map creates when you register an instance and specify this service. If you // want to use this service to register instances that create alias records, // specify WEIGHTED for the routing policy. You can specify the following values: // MULTIVALUE If you define a health check for the service and the health check is // healthy, Route 53 returns the applicable value for up to eight instances. For // example, suppose the service includes configurations for one A record and a // health check, and you use the service to register 10 instances. Route 53 // responds to DNS queries with IP addresses for up to eight healthy instances. If // fewer than eight instances are healthy, Route 53 responds to every DNS query // with the IP addresses for all of the healthy instances. If you don't define a // health check for the service, Route 53 assumes that all instances are healthy // and returns the values for up to eight instances. For more information about the // multivalue routing policy, see Multivalue Answer Routing // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue) // in the Route 53 Developer Guide. WEIGHTED Route 53 returns the applicable value // from one randomly selected instance from among the instances that you registered // using the same service. Currently, all records have the same weight, so you // can't route more or less traffic to any instances. For example, suppose the // service includes configurations for one A record and a health check, and you use // the service to register 10 instances. Route 53 responds to DNS queries with the // IP address for one randomly selected instance from among the healthy instances. // If no instances are healthy, Route 53 responds to DNS queries as if all of the // instances were healthy. If you don't define a health check for the service, // Route 53 assumes that all instances are healthy and returns the applicable value // for one randomly selected instance. For more information about the weighted // routing policy, see Weighted Routing // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted) // in the Route 53 Developer Guide. RoutingPolicy RoutingPolicy }
A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
type DnsConfigChange ¶
type DnsConfigChange struct { // An array that contains one DnsRecord object for each Route 53 record that you // want AWS Cloud Map to create when you register an instance. // // This member is required. DnsRecords []DnsRecord }
A complex type that contains information about changes to the Route 53 DNS records that AWS Cloud Map creates when you register an instance.
type DnsProperties ¶
type DnsProperties struct { // The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a // namespace. HostedZoneId *string }
A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
type DnsRecord ¶
type DnsRecord struct { // The amount of time, in seconds, that you want DNS resolvers to cache the // settings for this record. Alias records don't include a TTL because Route 53 // uses the TTL for the AWS resource that an alias record routes traffic to. If you // include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) // request, the TTL value is ignored. Always specify a TTL for the service; you can // use a service to register instances that create either alias or non-alias // records. // // This member is required. TTL *int64 // The type of the resource, which indicates the type of value that Route 53 // returns in response to DNS queries. You can specify values for Type in the // following combinations: // // * A // // * AAAA // // * A and AAAA // // * SRV // // * CNAME // // If you want // AWS Cloud Map to create a Route 53 alias record when you register an instance, // specify A or AAAA for Type. You specify other settings, such as the IP address // for A and AAAA records, when you register an instance. For more information, see // RegisterInstance // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html). // The following values are supported: A Route 53 returns the IP address of the // resource in IPv4 format, such as 192.0.2.44. AAAA Route 53 returns the IP // address of the resource in IPv6 format, such as // 2001:0db8:85a3:0000:0000:abcd:0001:2345. CNAME Route 53 returns the domain name // of the resource, such as www.example.com. Note the following: // // * You specify the // domain name that you want to route traffic to when you register an instance. For // more information, see Attributes // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes) // in the topic RegisterInstance // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html). // // * // You must specify WEIGHTED for the value of RoutingPolicy. // // * You can't specify // both CNAME for Type and settings for HealthCheckConfig. If you do, the request // will fail with an InvalidInput error. // // SRV Route 53 returns the value for an SRV // record. The value for an SRV record uses the following values: priority weight // port service-hostname Note the following about the values: // // * The values of // priority and weight are both set to 1 and can't be changed. // // * The value of port // comes from the value that you specify for the AWS_INSTANCE_PORT attribute when // you submit a RegisterInstance // (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) // request. // // * The value of service-hostname is a concatenation of the following // values: // // * The value that you specify for InstanceId when you register an // instance. // // * The name of the service. // // * The name of the namespace. // // For // example, if the value of InstanceId is test, the name of the service is backend, // and the name of the namespace is example.com, the value of service-hostname is: // test.backend.example.com // // If you specify settings for an SRV record, note the // following: // // * If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or // both in the RegisterInstance request, AWS Cloud Map automatically creates A // and/or AAAA records that have the same name as the value of service-hostname in // the SRV record. You can ignore these records. // // * If you're using a system that // requires a specific SRV format, such as HAProxy, see the Name // (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name) // element in the documentation about CreateService for information about how to // specify the correct name format. // // This member is required. Type RecordType }
A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
type DuplicateRequest ¶
The operation is already in progress.
func (*DuplicateRequest) Error ¶
func (e *DuplicateRequest) Error() string
func (*DuplicateRequest) ErrorCode ¶
func (e *DuplicateRequest) ErrorCode() string
func (*DuplicateRequest) ErrorFault ¶
func (e *DuplicateRequest) ErrorFault() smithy.ErrorFault
func (*DuplicateRequest) ErrorMessage ¶
func (e *DuplicateRequest) ErrorMessage() string
type FilterCondition ¶
type FilterCondition string
const ( FilterConditionEq FilterCondition = "EQ" FilterConditionIn FilterCondition = "IN" FilterConditionBetween FilterCondition = "BETWEEN" )
Enum values for FilterCondition
func (FilterCondition) Values ¶
func (FilterCondition) Values() []FilterCondition
Values returns all known values for FilterCondition. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type HealthCheckConfig ¶
type HealthCheckConfig struct { // The type of health check that you want to create, which indicates how Route 53 // determines whether an endpoint is healthy. You can't change the value of Type // after you create a health check. You can create the following types of health // checks: // // * HTTP: Route 53 tries to establish a TCP connection. If successful, // Route 53 submits an HTTP request and waits for an HTTP status code of 200 or // greater and less than 400. // // * HTTPS: Route 53 tries to establish a TCP // connection. If successful, Route 53 submits an HTTPS request and waits for an // HTTP status code of 200 or greater and less than 400. If you specify HTTPS for // the value of Type, the endpoint must support TLS v1.0 or later. // // * TCP: Route 53 // tries to establish a TCP connection. If you specify TCP for Type, don't specify // a value for ResourcePath. // // For more information, see How Route 53 Determines // Whether an Endpoint Is Healthy // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Route 53 Developer Guide. // // This member is required. Type HealthCheckType // The number of consecutive health checks that an endpoint must pass or fail for // Route 53 to change the current status of the endpoint from unhealthy to healthy // or vice versa. For more information, see How Route 53 Determines Whether an // Endpoint Is Healthy // (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html) // in the Route 53 Developer Guide. FailureThreshold *int32 // The path that you want Route 53 to request when performing health checks. The // path can be any value for which your endpoint will return an HTTP status code of // 2xx or 3xx when the endpoint is healthy, such as the file // /docs/route53-health-check.html. Route 53 automatically adds the DNS name for // the service. If you don't specify a value for ResourcePath, the default value is // /. If you specify TCP for Type, you must not specify a value for ResourcePath. ResourcePath *string }
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, 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 (http://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:
* Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth).
* 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 (http://aws.amazon.com/route53/pricing/).
type HealthCheckCustomConfig ¶
type HealthCheckCustomConfig struct { // This parameter has been deprecated and is always set to 1. AWS Cloud Map waits // for approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus // request before changing the status of the service instance. The number of // 30-second intervals that you want AWS Cloud Map to wait after receiving an // UpdateInstanceCustomHealthStatus request before it changes the health status of // a service instance. Sending a second or subsequent // UpdateInstanceCustomHealthStatus request with the same value before 30 seconds // has passed doesn't accelerate the change. AWS Cloud Map still waits 30 seconds // after the first request to make the change. // // Deprecated: Configurable FailureThreshold of HealthCheckCustomConfig is // deprecated. It will always have value 1. FailureThreshold *int32 }
A complex type that contains 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 is 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.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both. To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. AWS Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request. Here's how custom health checks work:
* You create a service and specify a value for FailureThreshold. The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus (https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html) request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource.
* You register an instance.
* You configure a third-party health checker to monitor the resource that is associated with the new instance. AWS Cloud Map doesn't check the health of the resource directly.
* The third-party health-checker determines that the resource is unhealthy and notifies your application.
* Your application submits an UpdateInstanceCustomHealthStatus request.
* AWS Cloud Map waits for (FailureThreshold x 30) seconds.
* If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource.
type HealthCheckType ¶
type HealthCheckType string
const ( HealthCheckTypeHttp HealthCheckType = "HTTP" HealthCheckTypeHttps HealthCheckType = "HTTPS" HealthCheckTypeTcp HealthCheckType = "TCP" )
Enum values for HealthCheckType
func (HealthCheckType) Values ¶
func (HealthCheckType) Values() []HealthCheckType
Values returns all known values for HealthCheckType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type HealthStatus ¶
type HealthStatus string
const ( HealthStatusHealthy HealthStatus = "HEALTHY" HealthStatusUnhealthy HealthStatus = "UNHEALTHY" HealthStatusUnknown HealthStatus = "UNKNOWN" )
Enum values for HealthStatus
func (HealthStatus) Values ¶
func (HealthStatus) Values() []HealthStatus
Values returns all known values for HealthStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type HealthStatusFilter ¶
type HealthStatusFilter string
const ( HealthStatusFilterHealthy HealthStatusFilter = "HEALTHY" HealthStatusFilterUnhealthy HealthStatusFilter = "UNHEALTHY" HealthStatusFilterAll HealthStatusFilter = "ALL" )
Enum values for HealthStatusFilter
func (HealthStatusFilter) Values ¶
func (HealthStatusFilter) Values() []HealthStatusFilter
Values returns all known values for HealthStatusFilter. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type HttpInstanceSummary ¶
type HttpInstanceSummary struct { // If you included any attributes when you registered the instance, the values of // those attributes. Attributes map[string]string // If you configured health checking in the service, the current health status of // the service instance. HealthStatus HealthStatus // The ID of an instance that matches the values that you specified in the request. InstanceId *string // The name of the namespace that you specified when you registered the instance. NamespaceName *string // The name of the service that you specified when you registered the instance. ServiceName *string }
In a response to a DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.
type HttpProperties ¶
type HttpProperties struct { // The name of an HTTP namespace. HttpName *string }
A complex type that contains the name of an HTTP namespace.
type Instance ¶
type Instance struct { // An identifier that you want to associate with the instance. Note the // following: // // * If the service that is specified by ServiceId includes settings // for an SRV record, the value of InstanceId is automatically included as part of // the value for the SRV record. For more information, see DnsRecord > Type // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type). // // * // You can use this value to update an existing instance. // // * To register a new // instance, you must specify a value that is unique among instances that you // register by using the same service. // // * If you specify an existing InstanceId and // ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an // existing health check, AWS Cloud Map deletes the old health check and creates a // new one. The health check isn't deleted immediately, so it will still appear for // a while if you submit a ListHealthChecks request, for example. // // This member is required. Id *string // A string map that contains the following information for the service that you // specify in ServiceId: // // * The attributes that apply to the records that are // defined in the service. // // * For each attribute, the applicable value. // // Supported // attribute keys include the following: AWS_ALIAS_DNS_NAME If you want AWS Cloud // Map to create a Route 53 alias record that routes traffic to an Elastic Load // Balancing load balancer, specify the DNS name that is associated with the load // balancer. For information about how to get the DNS name, see "DNSName" in the // topic AliasTarget // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html). // Note the following: // // * The configuration for the service that is specified by // ServiceId must include settings for an A record, an AAAA record, or both. // // * In // the service that is specified by ServiceId, the value of RoutingPolicy must be // WEIGHTED. // // * If the service that is specified by ServiceId includes // HealthCheckConfig settings, AWS Cloud Map will create the health check, but it // won't associate the health check with the alias record. // // * Auto naming currently // doesn't support creating alias records that route traffic to AWS resources other // than ELB load balancers. // // * If you specify a value for AWS_ALIAS_DNS_NAME, don't // specify values for any of the AWS_INSTANCE attributes. // // AWS_EC2_INSTANCE_ID HTTP // namespaces only. The Amazon EC2 instance ID for the instance. The // AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address. // AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the // domain name that you want Route 53 to return in response to DNS queries, for // example, example.com. This value is required if the service specified by // ServiceId includes settings for an CNAME record. AWS_INSTANCE_IPV4 If the // service configuration includes an A record, the IPv4 address that you want Route // 53 to return in response to DNS queries, for example, 192.0.2.44. This value is // required if the service specified by ServiceId includes settings for an A // record. If the service includes settings for an SRV record, you must specify a // value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_IPV6 If // the service configuration includes an AAAA record, the IPv6 address that you // want Route 53 to return in response to DNS queries, for example, // 2001:0db8:85a3:0000:0000:abcd:0001:2345. This value is required if the service // specified by ServiceId includes settings for an AAAA record. If the service // includes settings for an SRV record, you must specify a value for // AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both. AWS_INSTANCE_PORT If the service // includes an SRV record, the value that you want Route 53 to return for the port. // If the service includes HealthCheckConfig, the port on the endpoint that you // want Route 53 to send requests to. This value is required if you specified // settings for an SRV record or a Route 53 health check when you created the // service. Attributes map[string]string // A unique string that identifies the request and that allows failed // RegisterInstance requests to be retried without the risk of executing the // operation twice. You must use a unique CreatorRequestId string every time you // submit a RegisterInstance request if you're registering additional instances for // the same namespace and service. CreatorRequestId can be any unique string, for // example, a date/time stamp. CreatorRequestId *string }
A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request.
type InstanceNotFound ¶
type InstanceNotFound struct { Message *string }
No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
func (*InstanceNotFound) Error ¶
func (e *InstanceNotFound) Error() string
func (*InstanceNotFound) ErrorCode ¶
func (e *InstanceNotFound) ErrorCode() string
func (*InstanceNotFound) ErrorFault ¶
func (e *InstanceNotFound) ErrorFault() smithy.ErrorFault
func (*InstanceNotFound) ErrorMessage ¶
func (e *InstanceNotFound) ErrorMessage() string
type InstanceSummary ¶
type InstanceSummary struct { // A string map that contains the following information: // // * The attributes that are // associate with the instance. // // * For each attribute, the applicable // value. // // Supported attribute keys include the following: // // * AWS_ALIAS_DNS_NAME: // For an alias record that routes traffic to an Elastic Load Balancing load // balancer, the DNS name that is associated with the load balancer. // // * // AWS_EC2_INSTANCE_ID: (HTTP namespaces only) The Amazon EC2 instance ID for the // instance. When the AWS_EC2_INSTANCE_ID attribute is specified, then the // AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address. // // * // AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53 returns in // response to DNS queries, for example, example.com. // // * AWS_INSTANCE_IPV4: For an // A record, the IPv4 address that Route 53 returns in response to DNS queries, for // example, 192.0.2.44. // // * AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address // that Route 53 returns in response to DNS queries, for example, // 2001:0db8:85a3:0000:0000:abcd:0001:2345. // // * AWS_INSTANCE_PORT: For an SRV // record, the value that Route 53 returns for the port. In addition, if the // service includes HealthCheckConfig, the port on the endpoint that Route 53 sends // requests to. Attributes map[string]string // The ID for an instance that you created by using a specified service. Id *string }
A complex type that contains information about the instances that you registered by using a specified service.
type InvalidInput ¶
type InvalidInput struct { Message *string }
One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
func (*InvalidInput) Error ¶
func (e *InvalidInput) Error() string
func (*InvalidInput) ErrorCode ¶
func (e *InvalidInput) ErrorCode() string
func (*InvalidInput) ErrorFault ¶
func (e *InvalidInput) ErrorFault() smithy.ErrorFault
func (*InvalidInput) ErrorMessage ¶
func (e *InvalidInput) ErrorMessage() string
type Namespace ¶
type Namespace struct { // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when // you create it. Arn *string // The date that the namespace was created, in Unix date/time format and // Coordinated Universal Time (UTC). The value of CreateDate is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. CreateDate *time.Time // A unique string that identifies the request and that allows failed requests to // be retried without the risk of executing an operation twice. CreatorRequestId *string // The description that you specify for the namespace when you create it. Description *string // The ID of a namespace. Id *string // The name of the namespace, such as example.com. Name *string // A complex type that contains information that's specific to the type of the // namespace. Properties *NamespaceProperties // The number of services that are associated with the namespace. ServiceCount *int32 // The type of the namespace. The methods for discovering instances depends on the // value that you specify: // // * HTTP: Instances can be discovered only // programmatically, using the AWS Cloud Map DiscoverInstances API. // // * DNS_PUBLIC: // Instances can be discovered using public DNS queries and using the // DiscoverInstances API. // // * DNS_PRIVATE: Instances can be discovered using DNS // queries in VPCs and using the DiscoverInstances API. Type NamespaceType }
A complex type that contains information about a specified namespace.
type NamespaceAlreadyExists ¶
The namespace that you're trying to create already exists.
func (*NamespaceAlreadyExists) Error ¶
func (e *NamespaceAlreadyExists) Error() string
func (*NamespaceAlreadyExists) ErrorCode ¶
func (e *NamespaceAlreadyExists) ErrorCode() string
func (*NamespaceAlreadyExists) ErrorFault ¶
func (e *NamespaceAlreadyExists) ErrorFault() smithy.ErrorFault
func (*NamespaceAlreadyExists) ErrorMessage ¶
func (e *NamespaceAlreadyExists) ErrorMessage() string
type NamespaceFilter ¶
type NamespaceFilter struct { // Specify TYPE. // // This member is required. Name NamespaceFilterName // If you specify EQ for Condition, specify either DNS_PUBLIC or DNS_PRIVATE. If // you specify IN for Condition, you can specify DNS_PUBLIC, DNS_PRIVATE, or both. // // This member is required. Values []string // The operator that you want to use to determine whether ListNamespaces returns a // namespace. Valid values for condition include: // // * EQ: When you specify EQ for // the condition, you can choose to list only public namespaces or private // namespaces, but not both. EQ is the default condition and can be omitted. // // * IN: // When you specify IN for the condition, you can choose to list public namespaces, // private namespaces, or both. // // * BETWEEN: Not applicable Condition FilterCondition }
A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.
type NamespaceFilterName ¶
type NamespaceFilterName string
const ( NamespaceFilterNameType NamespaceFilterName = "TYPE" )
Enum values for NamespaceFilterName
func (NamespaceFilterName) Values ¶
func (NamespaceFilterName) Values() []NamespaceFilterName
Values returns all known values for NamespaceFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type NamespaceNotFound ¶
type NamespaceNotFound struct { Message *string }
No namespace exists with the specified ID.
func (*NamespaceNotFound) Error ¶
func (e *NamespaceNotFound) Error() string
func (*NamespaceNotFound) ErrorCode ¶
func (e *NamespaceNotFound) ErrorCode() string
func (*NamespaceNotFound) ErrorFault ¶
func (e *NamespaceNotFound) ErrorFault() smithy.ErrorFault
func (*NamespaceNotFound) ErrorMessage ¶
func (e *NamespaceNotFound) ErrorMessage() string
type NamespaceProperties ¶
type NamespaceProperties struct { // A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud // Map creates when you create a namespace. DnsProperties *DnsProperties // A complex type that contains the name of an HTTP namespace. HttpProperties *HttpProperties }
A complex type that contains information that is specific to the namespace type.
type NamespaceSummary ¶
type NamespaceSummary struct { // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when // you create it. Arn *string // The date and time that the namespace was created. CreateDate *time.Time // A description for the namespace. Description *string // The ID of the namespace. Id *string // The name of the namespace. When you create a namespace, AWS Cloud Map // automatically creates a Route 53 hosted zone that has the same name as the // namespace. Name *string // A complex type that contains information that is specific to the namespace type. Properties *NamespaceProperties // The number of services that were created using the namespace. ServiceCount *int32 // The type of the namespace, either public or private. Type NamespaceType }
A complex type that contains information about a namespace.
type NamespaceType ¶
type NamespaceType string
const ( NamespaceTypeDnsPublic NamespaceType = "DNS_PUBLIC" NamespaceTypeDnsPrivate NamespaceType = "DNS_PRIVATE" NamespaceTypeHttp NamespaceType = "HTTP" )
Enum values for NamespaceType
func (NamespaceType) Values ¶
func (NamespaceType) Values() []NamespaceType
Values returns all known values for NamespaceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type Operation ¶
type Operation struct { // The date and time that the request was submitted, in Unix date/time format and // Coordinated Universal Time (UTC). The value of CreateDate is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. CreateDate *time.Time // The code associated with ErrorMessage. Values for ErrorCode include the // following: // // * ACCESS_DENIED // // * CANNOT_CREATE_HOSTED_ZONE // // * EXPIRED_TOKEN // // * // HOSTED_ZONE_NOT_FOUND // // * INTERNAL_FAILURE // // * INVALID_CHANGE_BATCH // // * // THROTTLED_REQUEST ErrorCode *string // If the value of Status is FAIL, the reason that the operation failed. ErrorMessage *string // The ID of the operation that you want to get information about. Id *string // The status of the operation. Values include the following: // // * SUBMITTED: This is // the initial state immediately after you submit a request. // // * PENDING: AWS Cloud // Map is performing the operation. // // * SUCCESS: The operation succeeded. // // * FAIL: // The operation failed. For the failure reason, see ErrorMessage. Status OperationStatus // The name of the target entity that is associated with the operation: // // * // NAMESPACE: The namespace ID is returned in the ResourceId property. // // * SERVICE: // The service ID is returned in the ResourceId property. // // * INSTANCE: The instance // ID is returned in the ResourceId property. Targets map[string]string // The name of the operation that is associated with the specified ID. Type OperationType // The date and time that the value of Status changed to the current value, in Unix // date/time format and Coordinated Universal Time (UTC). The value of UpdateDate // is accurate to milliseconds. For example, the value 1516925490.087 represents // Friday, January 26, 2018 12:11:30.087 AM. UpdateDate *time.Time }
A complex type that contains information about a specified operation.
type OperationFilter ¶
type OperationFilter struct { // Specify the operations that you want to get: // // * NAMESPACE_ID: Gets operations // related to specified namespaces. // // * SERVICE_ID: Gets operations related to // specified services. // // * STATUS: Gets operations based on the status of the // operations: SUBMITTED, PENDING, SUCCEED, or FAIL. // // * TYPE: Gets specified types // of operation. // // * UPDATE_DATE: Gets operations that changed status during a // specified date/time range. // // This member is required. Name OperationFilterName // Specify values that are applicable to the value that you specify for Name: // // * // NAMESPACE_ID: Specify one namespace ID. // // * SERVICE_ID: Specify one service // ID. // // * STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or // FAIL. // // * TYPE: Specify one or more of the following types: CREATE_NAMESPACE, // DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE. // // * // UPDATE_DATE: Specify a start date and an end date in Unix date/time format and // Coordinated Universal Time (UTC). The start date must be the first value. // // This member is required. Values []string // The operator that you want to use to determine whether an operation matches the // specified value. Valid values for condition include: // // * EQ: When you specify EQ // for the condition, you can specify only one value. EQ is supported for // NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can // be omitted. // // * IN: When you specify IN for the condition, you can specify a list // of one or more values. IN is supported for STATUS and TYPE. An operation must // match one of the specified values to be returned in the response. // // * BETWEEN: // Specify a start date and an end date in Unix date/time format and Coordinated // Universal Time (UTC). The start date must be the first value. BETWEEN is // supported for UPDATE_DATE. Condition FilterCondition }
A complex type that lets you select the operations that you want to list.
type OperationFilterName ¶
type OperationFilterName string
const ( OperationFilterNameNamespaceId OperationFilterName = "NAMESPACE_ID" OperationFilterNameServiceId OperationFilterName = "SERVICE_ID" OperationFilterNameStatus OperationFilterName = "STATUS" OperationFilterNameType OperationFilterName = "TYPE" OperationFilterNameUpdateDate OperationFilterName = "UPDATE_DATE" )
Enum values for OperationFilterName
func (OperationFilterName) Values ¶
func (OperationFilterName) Values() []OperationFilterName
Values returns all known values for OperationFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type OperationNotFound ¶
type OperationNotFound struct { Message *string }
No operation exists with the specified ID.
func (*OperationNotFound) Error ¶
func (e *OperationNotFound) Error() string
func (*OperationNotFound) ErrorCode ¶
func (e *OperationNotFound) ErrorCode() string
func (*OperationNotFound) ErrorFault ¶
func (e *OperationNotFound) ErrorFault() smithy.ErrorFault
func (*OperationNotFound) ErrorMessage ¶
func (e *OperationNotFound) ErrorMessage() string
type OperationStatus ¶
type OperationStatus string
const ( OperationStatusSubmitted OperationStatus = "SUBMITTED" OperationStatusPending OperationStatus = "PENDING" OperationStatusSuccess OperationStatus = "SUCCESS" OperationStatusFail OperationStatus = "FAIL" )
Enum values for OperationStatus
func (OperationStatus) Values ¶
func (OperationStatus) Values() []OperationStatus
Values returns all known values for OperationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type OperationSummary ¶
type OperationSummary struct { // The ID for an operation. Id *string // The status of the operation. Values include the following: // // * SUBMITTED: This is // the initial state immediately after you submit a request. // // * PENDING: AWS Cloud // Map is performing the operation. // // * SUCCESS: The operation succeeded. // // * FAIL: // The operation failed. For the failure reason, see ErrorMessage. Status OperationStatus }
A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html) request.
type OperationTargetType ¶
type OperationTargetType string
const ( OperationTargetTypeNamespace OperationTargetType = "NAMESPACE" OperationTargetTypeService OperationTargetType = "SERVICE" OperationTargetTypeInstance OperationTargetType = "INSTANCE" )
Enum values for OperationTargetType
func (OperationTargetType) Values ¶
func (OperationTargetType) Values() []OperationTargetType
Values returns all known values for OperationTargetType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type OperationType ¶
type OperationType string
const ( OperationTypeCreateNamespace OperationType = "CREATE_NAMESPACE" OperationTypeDeleteNamespace OperationType = "DELETE_NAMESPACE" OperationTypeUpdateService OperationType = "UPDATE_SERVICE" OperationTypeRegisterInstance OperationType = "REGISTER_INSTANCE" OperationTypeDeregisterInstance OperationType = "DEREGISTER_INSTANCE" )
Enum values for OperationType
func (OperationType) Values ¶
func (OperationType) Values() []OperationType
Values returns all known values for OperationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type RecordType ¶
type RecordType string
const ( RecordTypeSrv RecordType = "SRV" RecordTypeA RecordType = "A" RecordTypeAaaa RecordType = "AAAA" RecordTypeCname RecordType = "CNAME" )
Enum values for RecordType
func (RecordType) Values ¶
func (RecordType) Values() []RecordType
Values returns all known values for RecordType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type RequestLimitExceeded ¶
type RequestLimitExceeded struct { Message *string }
The operation can't be completed because you've reached the quota for the number of requests. For more information, see AWS Cloud Map API request throttling quota (https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html) in the AWS Cloud Map Developer Guide.
func (*RequestLimitExceeded) Error ¶
func (e *RequestLimitExceeded) Error() string
func (*RequestLimitExceeded) ErrorCode ¶
func (e *RequestLimitExceeded) ErrorCode() string
func (*RequestLimitExceeded) ErrorFault ¶
func (e *RequestLimitExceeded) ErrorFault() smithy.ErrorFault
func (*RequestLimitExceeded) ErrorMessage ¶
func (e *RequestLimitExceeded) ErrorMessage() string
type ResourceInUse ¶
type ResourceInUse struct { Message *string }
The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
func (*ResourceInUse) Error ¶
func (e *ResourceInUse) Error() string
func (*ResourceInUse) ErrorCode ¶
func (e *ResourceInUse) ErrorCode() string
func (*ResourceInUse) ErrorFault ¶
func (e *ResourceInUse) ErrorFault() smithy.ErrorFault
func (*ResourceInUse) ErrorMessage ¶
func (e *ResourceInUse) ErrorMessage() string
type ResourceLimitExceeded ¶
type ResourceLimitExceeded struct { Message *string }
The resource can't be created because you've reached the quota on the number of resources.
func (*ResourceLimitExceeded) Error ¶
func (e *ResourceLimitExceeded) Error() string
func (*ResourceLimitExceeded) ErrorCode ¶
func (e *ResourceLimitExceeded) ErrorCode() string
func (*ResourceLimitExceeded) ErrorFault ¶
func (e *ResourceLimitExceeded) ErrorFault() smithy.ErrorFault
func (*ResourceLimitExceeded) ErrorMessage ¶
func (e *ResourceLimitExceeded) ErrorMessage() string
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string }
The operation can't be completed because the resource was not found.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type RoutingPolicy ¶
type RoutingPolicy string
const ( RoutingPolicyMultivalue RoutingPolicy = "MULTIVALUE" RoutingPolicyWeighted RoutingPolicy = "WEIGHTED" )
Enum values for RoutingPolicy
func (RoutingPolicy) Values ¶
func (RoutingPolicy) Values() []RoutingPolicy
Values returns all known values for RoutingPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type Service ¶
type Service struct { // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when // you create it. Arn *string // 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 value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreateDate *time.Time // A unique string that identifies the request and that allows failed requests to // be retried without the risk of executing the operation twice. CreatorRequestId // can be any unique string, for example, a date/time stamp. CreatorRequestId *string // The description of the service. Description *string // A complex type that contains information about the Route 53 DNS records that you // want AWS Cloud Map to create when you register an instance. DnsConfig *DnsConfig // 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, AWS 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 // (http://aws.amazon.com/route53/pricing/). HealthCheckConfig *HealthCheckConfig // A complex type that contains information about an optional custom health check. // If you specify a health check configuration, you can specify either // HealthCheckCustomConfig or HealthCheckConfig but not both. HealthCheckCustomConfig *HealthCheckCustomConfig // The ID that AWS Cloud Map assigned to the service when you created it. Id *string // The number of instances that are currently associated with the service. // Instances that were previously associated with the service but that have been // deleted are not included in the count. The count might not reflect pending // registrations and deregistrations. InstanceCount *int32 // The name of the service. Name *string // The ID of the namespace that was used to create the service. NamespaceId *string // 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. Type ServiceType }
A complex type that contains information about the specified service.
type ServiceAlreadyExists ¶
The service can't be created because a service with the same name already exists.
func (*ServiceAlreadyExists) Error ¶
func (e *ServiceAlreadyExists) Error() string
func (*ServiceAlreadyExists) ErrorCode ¶
func (e *ServiceAlreadyExists) ErrorCode() string
func (*ServiceAlreadyExists) ErrorFault ¶
func (e *ServiceAlreadyExists) ErrorFault() smithy.ErrorFault
func (*ServiceAlreadyExists) ErrorMessage ¶
func (e *ServiceAlreadyExists) ErrorMessage() string
type ServiceChange ¶
type ServiceChange struct { // A description for the service. Description *string // A complex type that contains information about the Route 53 DNS records that you // want AWS Cloud Map to create when you register an instance. DnsConfig *DnsConfigChange // 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, 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 // (http://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: // // * Route 53 automatically sets EvaluateTargetHealth to true // for alias records. When EvaluateTargetHealth is true, the alias record inherits // the health of the referenced AWS resource. such as an ELB load balancer. For // more information, see EvaluateTargetHealth // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth). // // * // 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 (http://aws.amazon.com/route53/pricing/). HealthCheckConfig *HealthCheckConfig }
A complex type that contains changes to an existing service.
type ServiceFilter ¶
type ServiceFilter struct { // Specify NAMESPACE_ID. // // This member is required. Name ServiceFilterName // The values that are applicable to the value that you specify for Condition to // filter the list of services. // // This member is required. Values []string // The operator that you want to use to determine whether a service is returned by // ListServices. Valid values for Condition include the following: // // * EQ: When you // specify EQ, specify one namespace ID for Values. EQ is the default condition and // can be omitted. // // * IN: When you specify IN, specify a list of the IDs for the // namespaces that you want ListServices to return a list of services for. // // * // BETWEEN: Not applicable. Condition FilterCondition }
A complex type that lets you specify the namespaces that you want to list services for.
type ServiceFilterName ¶
type ServiceFilterName string
const ( ServiceFilterNameNamespaceId ServiceFilterName = "NAMESPACE_ID" )
Enum values for ServiceFilterName
func (ServiceFilterName) Values ¶
func (ServiceFilterName) Values() []ServiceFilterName
Values returns all known values for ServiceFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ServiceNotFound ¶
type ServiceNotFound struct { Message *string }
No service exists with the specified ID.
func (*ServiceNotFound) Error ¶
func (e *ServiceNotFound) Error() string
func (*ServiceNotFound) ErrorCode ¶
func (e *ServiceNotFound) ErrorCode() string
func (*ServiceNotFound) ErrorFault ¶
func (e *ServiceNotFound) ErrorFault() smithy.ErrorFault
func (*ServiceNotFound) ErrorMessage ¶
func (e *ServiceNotFound) ErrorMessage() string
type ServiceSummary ¶
type ServiceSummary struct { // The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when // you create it. Arn *string // The date and time that the service was created. CreateDate *time.Time // The description that you specify when you create the service. Description *string // A complex type that contains information about the Amazon Route 53 DNS records // that you want AWS Cloud Map to create when you register an instance. DnsConfig *DnsConfig // 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, 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 // (http://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: // // * Route 53 automatically sets EvaluateTargetHealth to true // for alias records. When EvaluateTargetHealth is true, the alias record inherits // the health of the referenced AWS resource. such as an ELB load balancer. For // more information, see EvaluateTargetHealth // (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth). // // * // 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 (http://aws.amazon.com/route53/pricing/). HealthCheckConfig *HealthCheckConfig // A complex type that contains 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 is 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. // // If you specify a health check configuration, you can // specify either HealthCheckCustomConfig or HealthCheckConfig but not both. To // change the status of a custom health check, submit an // UpdateInstanceCustomHealthStatus request. AWS Cloud Map doesn't monitor the // status of the resource, it just keeps a record of the status specified in the // most recent UpdateInstanceCustomHealthStatus request. Here's how custom health // checks work: // // * You create a service and specify a value for FailureThreshold. // The failure threshold indicates the number of 30-second intervals you want AWS // Cloud Map to wait between the time that your application sends an // UpdateInstanceCustomHealthStatus // (https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html) // request and the time that AWS Cloud Map stops routing internet traffic to the // corresponding resource. // // * You register an instance. // // * You configure a // third-party health checker to monitor the resource that is associated with the // new instance. AWS Cloud Map doesn't check the health of the resource // directly. // // * The third-party health-checker determines that the resource is // unhealthy and notifies your application. // // * Your application submits an // UpdateInstanceCustomHealthStatus request. // // * AWS Cloud Map waits for // (FailureThreshold x 30) seconds. // // * If another UpdateInstanceCustomHealthStatus // request doesn't arrive during that time to change the status back to healthy, // AWS Cloud Map stops routing traffic to the resource. HealthCheckCustomConfig *HealthCheckCustomConfig // The ID that AWS Cloud Map assigned to the service when you created it. Id *string // The number of instances that are currently associated with the service. // Instances that were previously associated with the service but that have been // deleted are not included in the count. The count might not reflect pending // registrations and deregistrations. InstanceCount *int32 // The name of the service. Name *string // 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. Type ServiceType }
A complex type that contains information about a specified service.
type ServiceType ¶
type ServiceType string
const ( ServiceTypeHttp ServiceType = "HTTP" ServiceTypeDnsHttp ServiceType = "DNS_HTTP" ServiceTypeDns ServiceType = "DNS" )
Enum values for ServiceType
func (ServiceType) Values ¶
func (ServiceType) Values() []ServiceType
Values returns all known values for ServiceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type ServiceTypeOption ¶
type ServiceTypeOption string
const ( ServiceTypeOptionHttp ServiceTypeOption = "HTTP" )
Enum values for ServiceTypeOption
func (ServiceTypeOption) Values ¶
func (ServiceTypeOption) Values() []ServiceTypeOption
Values returns all known values for ServiceTypeOption. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.
type Tag ¶
type Tag struct { // The key identifier, or name, of the tag. // // This member is required. Key *string // The string value associated with the key of the tag. You can set the value of a // tag to an empty string, but you can't set the value of a tag to null. // // This member is required. Value *string }
A custom key-value pair associated with a resource.
type TooManyTagsException ¶
The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
func (*TooManyTagsException) Error ¶
func (e *TooManyTagsException) Error() string
func (*TooManyTagsException) ErrorCode ¶
func (e *TooManyTagsException) ErrorCode() string
func (*TooManyTagsException) ErrorFault ¶
func (e *TooManyTagsException) ErrorFault() smithy.ErrorFault
func (*TooManyTagsException) ErrorMessage ¶
func (e *TooManyTagsException) ErrorMessage() string
Source Files ¶
- Version
- v1.2.1
- Published
- Apr 2, 2021
- Platform
- js/wasm
- Imports
- 3 packages
- Last checked
- 9 hours ago –
Tools for package owners.