aws-sdk-servicediscovery 1.26.0 → 1.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9dcafc14b550a611110cc7ce9064785a5b9d88d6f2e88975bff8aca3e33e331c
|
4
|
+
data.tar.gz: 1e651749c5570c9dbe013755b71e588c5f40895e29972011f84f4461e19cda84
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1d23509c8d68c4ae92a22d883e5886fd7c543b6e221cf9888fa1683a3dce3487aa6919aaf27b3d5a0b587264fa9f75eec4f773f51cfeb13d9d35ee5f11902878
|
7
|
+
data.tar.gz: 5bb7b0cb0083dc280f3e8a27857a17e8044945dabaf5f639f37f110b38049ce6ec15592547ca221b2c36d5d68f86823624bee2ca23bcbb83bba3f9fdb85a0788
|
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-servicediscovery/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::ServiceDiscovery
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.31.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::ServiceDiscovery
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::ServiceDiscovery
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -326,8 +341,8 @@ module Aws::ServiceDiscovery
|
|
326
341
|
# an HTTP namespace can be discovered using a `DiscoverInstances`
|
327
342
|
# request but can't be discovered using DNS.
|
328
343
|
#
|
329
|
-
# For the current
|
330
|
-
# using the same AWS account, see [AWS Cloud Map
|
344
|
+
# For the current quota on the number of namespaces that you can create
|
345
|
+
# using the same AWS account, see [AWS Cloud Map quotas][1] in the *AWS
|
331
346
|
# Cloud Map Developer Guide*.
|
332
347
|
#
|
333
348
|
#
|
@@ -406,7 +421,7 @@ module Aws::ServiceDiscovery
|
|
406
421
|
# inside a specified Amazon VPC. The namespace defines your service
|
407
422
|
# naming scheme. For example, if you name your namespace `example.com`
|
408
423
|
# and name your service `backend`, the resulting DNS name for the
|
409
|
-
# service will be `backend.example.com`. For the current
|
424
|
+
# service will be `backend.example.com`. For the current quota on the
|
410
425
|
# number of namespaces that you can create using the same AWS account,
|
411
426
|
# see [AWS Cloud Map Limits][1] in the *AWS Cloud Map Developer Guide*.
|
412
427
|
#
|
@@ -417,7 +432,7 @@ module Aws::ServiceDiscovery
|
|
417
432
|
# @option params [required, String] :name
|
418
433
|
# The name that you want to assign to this namespace. When you create a
|
419
434
|
# private DNS namespace, AWS Cloud Map automatically creates an Amazon
|
420
|
-
# Route
|
435
|
+
# Route 53 private hosted zone that has the same name as the namespace.
|
421
436
|
#
|
422
437
|
# @option params [String] :creator_request_id
|
423
438
|
# A unique string that identifies the request and that allows failed
|
@@ -493,7 +508,7 @@ module Aws::ServiceDiscovery
|
|
493
508
|
# internet. The namespace defines your service naming scheme. For
|
494
509
|
# example, if you name your namespace `example.com` and name your
|
495
510
|
# service `backend`, the resulting DNS name for the service will be
|
496
|
-
# `backend.example.com`. For the current
|
511
|
+
# `backend.example.com`. For the current quota on the number of
|
497
512
|
# namespaces that you can create using the same AWS account, see [AWS
|
498
513
|
# Cloud Map Limits][1] in the *AWS Cloud Map Developer Guide*.
|
499
514
|
#
|
@@ -573,17 +588,17 @@ module Aws::ServiceDiscovery
|
|
573
588
|
# entities:
|
574
589
|
#
|
575
590
|
# * For public and private DNS namespaces, one of the following
|
576
|
-
# combinations of DNS records in Amazon Route
|
591
|
+
# combinations of DNS records in Amazon Route 53:
|
577
592
|
#
|
578
|
-
# * A
|
593
|
+
# * `A`
|
579
594
|
#
|
580
|
-
# * AAAA
|
595
|
+
# * `AAAA`
|
581
596
|
#
|
582
|
-
# * A and AAAA
|
597
|
+
# * `A` and `AAAA`
|
583
598
|
#
|
584
|
-
# * SRV
|
599
|
+
# * `SRV`
|
585
600
|
#
|
586
|
-
# * CNAME
|
601
|
+
# * `CNAME`
|
587
602
|
#
|
588
603
|
# * Optionally, a health check
|
589
604
|
#
|
@@ -591,7 +606,7 @@ module Aws::ServiceDiscovery
|
|
591
606
|
# request, and AWS Cloud Map uses the values in the configuration to
|
592
607
|
# create the specified entities.
|
593
608
|
#
|
594
|
-
# For the current
|
609
|
+
# For the current quota on the number of instances that you can register
|
595
610
|
# using the same namespace and using the same service, see [AWS Cloud
|
596
611
|
# Map Limits][2] in the *AWS Cloud Map Developer Guide*.
|
597
612
|
#
|
@@ -603,17 +618,17 @@ module Aws::ServiceDiscovery
|
|
603
618
|
# @option params [required, String] :name
|
604
619
|
# The name that you want to assign to the service.
|
605
620
|
#
|
606
|
-
# If you want AWS Cloud Map to create an SRV record when you register
|
607
|
-
# instance, and if you're using a system that requires a specific
|
608
|
-
# format, such as [HAProxy][1], specify the following for `Name`\:
|
621
|
+
# If you want AWS Cloud Map to create an `SRV` record when you register
|
622
|
+
# an instance, and if you're using a system that requires a specific
|
623
|
+
# `SRV` format, such as [HAProxy][1], specify the following for `Name`\:
|
609
624
|
#
|
610
625
|
# * Start the name with an underscore (\_), such as `_exampleservice`
|
611
626
|
#
|
612
627
|
# * End the name with *.\_protocol*, such as `._tcp`
|
613
628
|
#
|
614
|
-
# When you register an instance, AWS Cloud Map creates an SRV record
|
615
|
-
# assigns a name to the record by concatenating the service name and
|
616
|
-
# namespace name, for example:
|
629
|
+
# When you register an instance, AWS Cloud Map creates an `SRV` record
|
630
|
+
# and assigns a name to the record by concatenating the service name and
|
631
|
+
# the namespace name, for example:
|
617
632
|
#
|
618
633
|
# `_exampleservice._tcp.example.com`
|
619
634
|
#
|
@@ -637,15 +652,15 @@ module Aws::ServiceDiscovery
|
|
637
652
|
# A description for the service.
|
638
653
|
#
|
639
654
|
# @option params [Types::DnsConfig] :dns_config
|
640
|
-
# A complex type that contains information about the Amazon Route
|
655
|
+
# A complex type that contains information about the Amazon Route 53
|
641
656
|
# records that you want AWS Cloud Map to create when you register an
|
642
657
|
# instance.
|
643
658
|
#
|
644
659
|
# @option params [Types::HealthCheckConfig] :health_check_config
|
645
660
|
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
646
|
-
# settings for an optional Route
|
661
|
+
# settings for an optional Route 53 health check. If you specify
|
647
662
|
# settings for a health check, AWS Cloud Map associates the health check
|
648
|
-
# with all the Route
|
663
|
+
# with all the Route 53 DNS records that you specify in `DnsConfig`.
|
649
664
|
#
|
650
665
|
# If you specify a health check configuration, you can specify either
|
651
666
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
@@ -861,7 +876,7 @@ module Aws::ServiceDiscovery
|
|
861
876
|
req.send_request(options)
|
862
877
|
end
|
863
878
|
|
864
|
-
# Deletes the Amazon Route
|
879
|
+
# Deletes the Amazon Route 53 DNS records and health check, if any, that
|
865
880
|
# AWS Cloud Map created for the specified instance.
|
866
881
|
#
|
867
882
|
# @option params [required, String] :service_id
|
@@ -934,10 +949,16 @@ module Aws::ServiceDiscovery
|
|
934
949
|
# instances.
|
935
950
|
#
|
936
951
|
# @option params [Hash<String,String>] :query_parameters
|
937
|
-
#
|
938
|
-
#
|
939
|
-
#
|
940
|
-
#
|
952
|
+
# Filters to scope the results based on custom attributes for the
|
953
|
+
# instance. For example, `\{version=v1, az=1a\}`. Only instances that
|
954
|
+
# match all the specified key-value pairs will be returned.
|
955
|
+
#
|
956
|
+
# @option params [Hash<String,String>] :optional_parameters
|
957
|
+
# Opportunistic filters to scope the results based on custom attributes.
|
958
|
+
# If there are instances that match both the filters specified in both
|
959
|
+
# the `QueryParameters` parameter and this parameter, they are returned.
|
960
|
+
# Otherwise, these filters are ignored and only instances that match the
|
961
|
+
# filters specified in the `QueryParameters` parameter are returned.
|
941
962
|
#
|
942
963
|
# @option params [String] :health_status
|
943
964
|
# The health status of the instances that you want to discover.
|
@@ -983,6 +1004,9 @@ module Aws::ServiceDiscovery
|
|
983
1004
|
# query_parameters: {
|
984
1005
|
# "AttrKey" => "AttrValue",
|
985
1006
|
# },
|
1007
|
+
# optional_parameters: {
|
1008
|
+
# "AttrKey" => "AttrValue",
|
1009
|
+
# },
|
986
1010
|
# health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
|
987
1011
|
# })
|
988
1012
|
#
|
@@ -1861,7 +1885,7 @@ module Aws::ServiceDiscovery
|
|
1861
1885
|
# * **If you didn't specify a health check configuration**\: returns
|
1862
1886
|
# all the records
|
1863
1887
|
#
|
1864
|
-
# For the current
|
1888
|
+
# For the current quota on the number of instances that you can register
|
1865
1889
|
# using the same namespace and using the same service, see [AWS Cloud
|
1866
1890
|
# Map Limits][2] in the *AWS Cloud Map Developer Guide*.
|
1867
1891
|
#
|
@@ -1879,8 +1903,8 @@ module Aws::ServiceDiscovery
|
|
1879
1903
|
# following:
|
1880
1904
|
#
|
1881
1905
|
# * If the service that is specified by `ServiceId` includes settings
|
1882
|
-
# for an SRV record, the value of `InstanceId` is automatically
|
1883
|
-
# included as part of the value for the SRV record. For more
|
1906
|
+
# for an `SRV` record, the value of `InstanceId` is automatically
|
1907
|
+
# included as part of the value for the `SRV` record. For more
|
1884
1908
|
# information, see [DnsRecord > Type][1].
|
1885
1909
|
#
|
1886
1910
|
# * You can use this value to update an existing instance.
|
@@ -1927,33 +1951,41 @@ module Aws::ServiceDiscovery
|
|
1927
1951
|
#
|
1928
1952
|
# **AWS\_ALIAS\_DNS\_NAME**
|
1929
1953
|
#
|
1930
|
-
#
|
1931
|
-
#
|
1932
|
-
# If you want AWS Cloud Map to create an Amazon Route 53 alias record
|
1954
|
+
# If you want AWS Cloud Map to create an Amazon Route 53 alias record
|
1933
1955
|
# that routes traffic to an Elastic Load Balancing load balancer,
|
1934
1956
|
# specify the DNS name that is associated with the load balancer. For
|
1935
1957
|
# information about how to get the DNS name, see "DNSName" in the
|
1936
|
-
# topic [AliasTarget][1] in the *Route
|
1958
|
+
# topic [AliasTarget][1] in the *Route 53 API Reference*.
|
1937
1959
|
#
|
1938
1960
|
# Note the following:
|
1939
1961
|
#
|
1940
1962
|
# * The configuration for the service that is specified by `ServiceId`
|
1941
|
-
# must include settings for an A record, an AAAA record, or both.
|
1963
|
+
# must include settings for an `A` record, an `AAAA` record, or both.
|
1942
1964
|
#
|
1943
1965
|
# * In the service that is specified by `ServiceId`, the value of
|
1944
1966
|
# `RoutingPolicy` must be `WEIGHTED`.
|
1945
1967
|
#
|
1946
1968
|
# * If the service that is specified by `ServiceId` includes
|
1947
|
-
# `HealthCheckConfig` settings, AWS Cloud Map will create the Route
|
1969
|
+
# `HealthCheckConfig` settings, AWS Cloud Map will create the Route 53
|
1948
1970
|
# health check, but it won't associate the health check with the
|
1949
1971
|
# alias record.
|
1950
1972
|
#
|
1951
1973
|
# * Auto naming currently doesn't support creating alias records that
|
1952
|
-
# route traffic to AWS resources other than
|
1974
|
+
# route traffic to AWS resources other than Elastic Load Balancing
|
1975
|
+
# load balancers.
|
1953
1976
|
#
|
1954
1977
|
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
1955
1978
|
# values for any of the `AWS_INSTANCE` attributes.
|
1956
1979
|
#
|
1980
|
+
# **AWS\_EC2\_INSTANCE\_ID**
|
1981
|
+
#
|
1982
|
+
# *HTTP namespaces only.* The Amazon EC2 instance ID for the instance.
|
1983
|
+
# If the `AWS_EC2_INSTANCE_ID` attribute is specified, then the only
|
1984
|
+
# other attribute that can be specified is `AWS_INIT_HEALTH_STATUS`.
|
1985
|
+
# When the `AWS_EC2_INSTANCE_ID` attribute is specified, then the
|
1986
|
+
# `AWS_INSTANCE_IPV4` attribute will be filled out with the primary
|
1987
|
+
# private IPv4 address.
|
1988
|
+
#
|
1957
1989
|
# **AWS\_INIT\_HEALTH\_STATUS**
|
1958
1990
|
#
|
1959
1991
|
# If the service configuration includes `HealthCheckCustomConfig`, you
|
@@ -1964,52 +1996,52 @@ module Aws::ServiceDiscovery
|
|
1964
1996
|
#
|
1965
1997
|
# **AWS\_INSTANCE\_CNAME**
|
1966
1998
|
#
|
1967
|
-
# If the service configuration includes a CNAME record, the domain
|
1968
|
-
# that you want Route
|
1999
|
+
# If the service configuration includes a `CNAME` record, the domain
|
2000
|
+
# name that you want Route 53 to return in response to DNS queries, for
|
1969
2001
|
# example, `example.com`.
|
1970
2002
|
#
|
1971
2003
|
# This value is required if the service specified by `ServiceId`
|
1972
|
-
# includes settings for an CNAME record.
|
2004
|
+
# includes settings for an `CNAME` record.
|
1973
2005
|
#
|
1974
2006
|
# **AWS\_INSTANCE\_IPV4**
|
1975
2007
|
#
|
1976
|
-
# If the service configuration includes an A record, the IPv4 address
|
1977
|
-
# that you want Route
|
2008
|
+
# If the service configuration includes an `A` record, the IPv4 address
|
2009
|
+
# that you want Route 53 to return in response to DNS queries, for
|
1978
2010
|
# example, `192.0.2.44`.
|
1979
2011
|
#
|
1980
2012
|
# This value is required if the service specified by `ServiceId`
|
1981
|
-
# includes settings for an A record. If the service includes settings
|
1982
|
-
# for an SRV record, you must specify a value for `AWS_INSTANCE_IPV4`,
|
2013
|
+
# includes settings for an `A` record. If the service includes settings
|
2014
|
+
# for an `SRV` record, you must specify a value for `AWS_INSTANCE_IPV4`,
|
1983
2015
|
# `AWS_INSTANCE_IPV6`, or both.
|
1984
2016
|
#
|
1985
2017
|
# **AWS\_INSTANCE\_IPV6**
|
1986
2018
|
#
|
1987
|
-
# If the service configuration includes an AAAA record, the IPv6
|
1988
|
-
# that you want Route
|
1989
|
-
# example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
2019
|
+
# If the service configuration includes an `AAAA` record, the IPv6
|
2020
|
+
# address that you want Route 53 to return in response to DNS queries,
|
2021
|
+
# for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
1990
2022
|
#
|
1991
2023
|
# This value is required if the service specified by `ServiceId`
|
1992
|
-
# includes settings for an AAAA record. If the service includes
|
1993
|
-
# for an SRV record, you must specify a value for
|
1994
|
-
# `AWS_INSTANCE_IPV6`, or both.
|
2024
|
+
# includes settings for an `AAAA` record. If the service includes
|
2025
|
+
# settings for an `SRV` record, you must specify a value for
|
2026
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1995
2027
|
#
|
1996
2028
|
# **AWS\_INSTANCE\_PORT**
|
1997
2029
|
#
|
1998
|
-
# If the service includes an SRV record, the value that you want
|
1999
|
-
# 53 to return for the port.
|
2030
|
+
# If the service includes an `SRV` record, the value that you want
|
2031
|
+
# Route 53 to return for the port.
|
2000
2032
|
#
|
2001
2033
|
# If the service includes `HealthCheckConfig`, the port on the endpoint
|
2002
|
-
# that you want Route
|
2034
|
+
# that you want Route 53 to send requests to.
|
2003
2035
|
#
|
2004
|
-
# This value is required if you specified settings for an SRV record
|
2005
|
-
# a Route
|
2036
|
+
# This value is required if you specified settings for an `SRV` record
|
2037
|
+
# or a Route 53 health check when you created the service.
|
2006
2038
|
#
|
2007
2039
|
# **Custom attributes**
|
2008
2040
|
#
|
2009
2041
|
# You can add up to 30 custom attributes. For each key-value pair, the
|
2010
2042
|
# maximum length of the attribute name is 255 characters, and the
|
2011
|
-
# maximum length of the attribute value is 1,024 characters.
|
2012
|
-
# of all provided attributes (sum of all keys and values) must not
|
2043
|
+
# maximum length of the attribute value is 1,024 characters. The total
|
2044
|
+
# size of all provided attributes (sum of all keys and values) must not
|
2013
2045
|
# exceed 5,000 characters.
|
2014
2046
|
#
|
2015
2047
|
#
|
@@ -2171,7 +2203,7 @@ module Aws::ServiceDiscovery
|
|
2171
2203
|
# You can use `UpdateInstanceCustomHealthStatus` to change the status
|
2172
2204
|
# only for custom health checks, which you define using
|
2173
2205
|
# `HealthCheckCustomConfig` when you create a service. You can't use it
|
2174
|
-
# to change the status for Route
|
2206
|
+
# to change the status for Route 53 health checks, which you define
|
2175
2207
|
# using `HealthCheckConfig`.
|
2176
2208
|
#
|
2177
2209
|
# For more information, see [HealthCheckCustomConfig][1].
|
@@ -2333,7 +2365,7 @@ module Aws::ServiceDiscovery
|
|
2333
2365
|
params: params,
|
2334
2366
|
config: config)
|
2335
2367
|
context[:gem_name] = 'aws-sdk-servicediscovery'
|
2336
|
-
context[:gem_version] = '1.
|
2368
|
+
context[:gem_version] = '1.31.0'
|
2337
2369
|
Seahorse::Client::Request.new(handlers, context)
|
2338
2370
|
end
|
2339
2371
|
|
@@ -217,6 +217,7 @@ module Aws::ServiceDiscovery
|
|
217
217
|
DiscoverInstancesRequest.add_member(:service_name, Shapes::ShapeRef.new(shape: ServiceName, required: true, location_name: "ServiceName"))
|
218
218
|
DiscoverInstancesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: DiscoverMaxResults, location_name: "MaxResults"))
|
219
219
|
DiscoverInstancesRequest.add_member(:query_parameters, Shapes::ShapeRef.new(shape: Attributes, location_name: "QueryParameters"))
|
220
|
+
DiscoverInstancesRequest.add_member(:optional_parameters, Shapes::ShapeRef.new(shape: Attributes, location_name: "OptionalParameters"))
|
220
221
|
DiscoverInstancesRequest.add_member(:health_status, Shapes::ShapeRef.new(shape: HealthStatusFilter, location_name: "HealthStatus"))
|
221
222
|
DiscoverInstancesRequest.struct_class = Types::DiscoverInstancesRequest
|
222
223
|
|
@@ -98,7 +98,7 @@ module Aws::ServiceDiscovery
|
|
98
98
|
# @!attribute [rw] name
|
99
99
|
# The name that you want to assign to this namespace. When you create
|
100
100
|
# a private DNS namespace, AWS Cloud Map automatically creates an
|
101
|
-
# Amazon Route
|
101
|
+
# Amazon Route 53 private hosted zone that has the same name as the
|
102
102
|
# namespace.
|
103
103
|
# @return [String]
|
104
104
|
#
|
@@ -264,15 +264,16 @@ module Aws::ServiceDiscovery
|
|
264
264
|
# @!attribute [rw] name
|
265
265
|
# The name that you want to assign to the service.
|
266
266
|
#
|
267
|
-
# If you want AWS Cloud Map to create an SRV record when you
|
268
|
-
# an instance, and if you're using a system that requires a
|
269
|
-
# SRV format, such as [HAProxy][1], specify the following
|
267
|
+
# If you want AWS Cloud Map to create an `SRV` record when you
|
268
|
+
# register an instance, and if you're using a system that requires a
|
269
|
+
# specific `SRV` format, such as [HAProxy][1], specify the following
|
270
|
+
# for `Name`\:
|
270
271
|
#
|
271
272
|
# * Start the name with an underscore (\_), such as `_exampleservice`
|
272
273
|
#
|
273
274
|
# * End the name with *.\_protocol*, such as `._tcp`
|
274
275
|
#
|
275
|
-
# When you register an instance, AWS Cloud Map creates an SRV record
|
276
|
+
# When you register an instance, AWS Cloud Map creates an `SRV` record
|
276
277
|
# and assigns a name to the record by concatenating the service name
|
277
278
|
# and the namespace name, for example:
|
278
279
|
#
|
@@ -302,16 +303,16 @@ module Aws::ServiceDiscovery
|
|
302
303
|
# @return [String]
|
303
304
|
#
|
304
305
|
# @!attribute [rw] dns_config
|
305
|
-
# A complex type that contains information about the Amazon Route
|
306
|
+
# A complex type that contains information about the Amazon Route 53
|
306
307
|
# records that you want AWS Cloud Map to create when you register an
|
307
308
|
# instance.
|
308
309
|
# @return [Types::DnsConfig]
|
309
310
|
#
|
310
311
|
# @!attribute [rw] health_check_config
|
311
312
|
# *Public DNS and HTTP namespaces only.* A complex type that contains
|
312
|
-
# settings for an optional Route
|
313
|
+
# settings for an optional Route 53 health check. If you specify
|
313
314
|
# settings for a health check, AWS Cloud Map associates the health
|
314
|
-
# check with all the Route
|
315
|
+
# check with all the Route 53 DNS records that you specify in
|
315
316
|
# `DnsConfig`.
|
316
317
|
#
|
317
318
|
# If you specify a health check configuration, you can specify either
|
@@ -501,6 +502,9 @@ module Aws::ServiceDiscovery
|
|
501
502
|
# query_parameters: {
|
502
503
|
# "AttrKey" => "AttrValue",
|
503
504
|
# },
|
505
|
+
# optional_parameters: {
|
506
|
+
# "AttrKey" => "AttrValue",
|
507
|
+
# },
|
504
508
|
# health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
|
505
509
|
# }
|
506
510
|
#
|
@@ -522,10 +526,18 @@ module Aws::ServiceDiscovery
|
|
522
526
|
# @return [Integer]
|
523
527
|
#
|
524
528
|
# @!attribute [rw] query_parameters
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
+
# Filters to scope the results based on custom attributes for the
|
530
|
+
# instance. For example, `\{version=v1, az=1a\}`. Only instances that
|
531
|
+
# match all the specified key-value pairs will be returned.
|
532
|
+
# @return [Hash<String,String>]
|
533
|
+
#
|
534
|
+
# @!attribute [rw] optional_parameters
|
535
|
+
# Opportunistic filters to scope the results based on custom
|
536
|
+
# attributes. If there are instances that match both the filters
|
537
|
+
# specified in both the `QueryParameters` parameter and this
|
538
|
+
# parameter, they are returned. Otherwise, these filters are ignored
|
539
|
+
# and only instances that match the filters specified in the
|
540
|
+
# `QueryParameters` parameter are returned.
|
529
541
|
# @return [Hash<String,String>]
|
530
542
|
#
|
531
543
|
# @!attribute [rw] health_status
|
@@ -539,6 +551,7 @@ module Aws::ServiceDiscovery
|
|
539
551
|
:service_name,
|
540
552
|
:max_results,
|
541
553
|
:query_parameters,
|
554
|
+
:optional_parameters,
|
542
555
|
:health_status)
|
543
556
|
SENSITIVE = []
|
544
557
|
include Aws::Structure
|
@@ -557,7 +570,7 @@ module Aws::ServiceDiscovery
|
|
557
570
|
include Aws::Structure
|
558
571
|
end
|
559
572
|
|
560
|
-
# A complex type that contains information about the Amazon Route
|
573
|
+
# A complex type that contains information about the Amazon Route 53 DNS
|
561
574
|
# records that you want AWS Cloud Map to create when you register an
|
562
575
|
# instance.
|
563
576
|
#
|
@@ -580,7 +593,7 @@ module Aws::ServiceDiscovery
|
|
580
593
|
# @return [String]
|
581
594
|
#
|
582
595
|
# @!attribute [rw] routing_policy
|
583
|
-
# The routing policy that you want to apply to all Route
|
596
|
+
# The routing policy that you want to apply to all Route 53 DNS
|
584
597
|
# records that AWS Cloud Map creates when you register an instance and
|
585
598
|
# specify this service.
|
586
599
|
#
|
@@ -594,43 +607,43 @@ module Aws::ServiceDiscovery
|
|
594
607
|
# **MULTIVALUE**
|
595
608
|
#
|
596
609
|
# If you define a health check for the service and the health check is
|
597
|
-
# healthy, Route
|
610
|
+
# healthy, Route 53 returns the applicable value for up to eight
|
598
611
|
# instances.
|
599
612
|
#
|
600
|
-
# For example, suppose the service includes configurations for one A
|
613
|
+
# For example, suppose the service includes configurations for one `A`
|
601
614
|
# record and a health check, and you use the service to register 10
|
602
|
-
# instances. Route
|
615
|
+
# instances. Route 53 responds to DNS queries with IP addresses for up
|
603
616
|
# to eight healthy instances. If fewer than eight instances are
|
604
|
-
# healthy, Route
|
617
|
+
# healthy, Route 53 responds to every DNS query with the IP addresses
|
605
618
|
# for all of the healthy instances.
|
606
619
|
#
|
607
|
-
# If you don't define a health check for the service, Route
|
620
|
+
# If you don't define a health check for the service, Route 53
|
608
621
|
# assumes that all instances are healthy and returns the values for up
|
609
622
|
# to eight instances.
|
610
623
|
#
|
611
624
|
# For more information about the multivalue routing policy, see
|
612
|
-
# [Multivalue Answer Routing][1] in the *Route
|
625
|
+
# [Multivalue Answer Routing][1] in the *Route 53 Developer Guide*.
|
613
626
|
#
|
614
627
|
# **WEIGHTED**
|
615
628
|
#
|
616
|
-
# Route
|
629
|
+
# Route 53 returns the applicable value from one randomly selected
|
617
630
|
# instance from among the instances that you registered using the same
|
618
631
|
# service. Currently, all records have the same weight, so you can't
|
619
632
|
# route more or less traffic to any instances.
|
620
633
|
#
|
621
|
-
# For example, suppose the service includes configurations for one A
|
634
|
+
# For example, suppose the service includes configurations for one `A`
|
622
635
|
# record and a health check, and you use the service to register 10
|
623
|
-
# instances. Route
|
636
|
+
# instances. Route 53 responds to DNS queries with the IP address for
|
624
637
|
# one randomly selected instance from among the healthy instances. If
|
625
|
-
# no instances are healthy, Route
|
638
|
+
# no instances are healthy, Route 53 responds to DNS queries as if all
|
626
639
|
# of the instances were healthy.
|
627
640
|
#
|
628
|
-
# If you don't define a health check for the service, Route
|
641
|
+
# If you don't define a health check for the service, Route 53
|
629
642
|
# assumes that all instances are healthy and returns the applicable
|
630
643
|
# value for one randomly selected instance.
|
631
644
|
#
|
632
645
|
# For more information about the weighted routing policy, see
|
633
|
-
# [Weighted Routing][2] in the *Route
|
646
|
+
# [Weighted Routing][2] in the *Route 53 Developer Guide*.
|
634
647
|
#
|
635
648
|
#
|
636
649
|
#
|
@@ -639,7 +652,7 @@ module Aws::ServiceDiscovery
|
|
639
652
|
# @return [String]
|
640
653
|
#
|
641
654
|
# @!attribute [rw] dns_records
|
642
|
-
# An array that contains one `DnsRecord` object for each Route
|
655
|
+
# An array that contains one `DnsRecord` object for each Route 53 DNS
|
643
656
|
# record that you want AWS Cloud Map to create when you register an
|
644
657
|
# instance.
|
645
658
|
# @return [Array<Types::DnsRecord>]
|
@@ -654,7 +667,7 @@ module Aws::ServiceDiscovery
|
|
654
667
|
include Aws::Structure
|
655
668
|
end
|
656
669
|
|
657
|
-
# A complex type that contains information about changes to the Route
|
670
|
+
# A complex type that contains information about changes to the Route 53
|
658
671
|
# DNS records that AWS Cloud Map creates when you register an instance.
|
659
672
|
#
|
660
673
|
# @note When making an API call, you may pass DnsConfigChange
|
@@ -670,7 +683,7 @@ module Aws::ServiceDiscovery
|
|
670
683
|
# }
|
671
684
|
#
|
672
685
|
# @!attribute [rw] dns_records
|
673
|
-
# An array that contains one `DnsRecord` object for each Route
|
686
|
+
# An array that contains one `DnsRecord` object for each Route 53
|
674
687
|
# record that you want AWS Cloud Map to create when you register an
|
675
688
|
# instance.
|
676
689
|
# @return [Array<Types::DnsRecord>]
|
@@ -683,11 +696,11 @@ module Aws::ServiceDiscovery
|
|
683
696
|
include Aws::Structure
|
684
697
|
end
|
685
698
|
|
686
|
-
# A complex type that contains the ID for the Route
|
699
|
+
# A complex type that contains the ID for the Route 53 hosted zone that
|
687
700
|
# AWS Cloud Map creates when you create a namespace.
|
688
701
|
#
|
689
702
|
# @!attribute [rw] hosted_zone_id
|
690
|
-
# The ID for the Route
|
703
|
+
# The ID for the Route 53 hosted zone that AWS Cloud Map creates when
|
691
704
|
# you create a namespace.
|
692
705
|
# @return [String]
|
693
706
|
#
|
@@ -699,7 +712,7 @@ module Aws::ServiceDiscovery
|
|
699
712
|
include Aws::Structure
|
700
713
|
end
|
701
714
|
|
702
|
-
# A complex type that contains information about the Route
|
715
|
+
# A complex type that contains information about the Route 53 DNS
|
703
716
|
# records that you want AWS Cloud Map to create when you register an
|
704
717
|
# instance.
|
705
718
|
#
|
@@ -713,110 +726,91 @@ module Aws::ServiceDiscovery
|
|
713
726
|
#
|
714
727
|
# @!attribute [rw] type
|
715
728
|
# The type of the resource, which indicates the type of value that
|
716
|
-
# Route
|
729
|
+
# Route 53 returns in response to DNS queries. You can specify values
|
717
730
|
# for `Type` in the following combinations:
|
718
731
|
#
|
719
|
-
# * A
|
732
|
+
# * `A`
|
720
733
|
#
|
721
|
-
# * AAAA
|
734
|
+
# * `AAAA`
|
722
735
|
#
|
723
|
-
# * A and AAAA
|
736
|
+
# * `A` and `AAAA`
|
724
737
|
#
|
725
|
-
# * SRV
|
738
|
+
# * `SRV`
|
726
739
|
#
|
727
|
-
# * CNAME
|
740
|
+
# * `CNAME`
|
728
741
|
#
|
729
|
-
# If you want AWS Cloud Map to create a Route
|
742
|
+
# If you want AWS Cloud Map to create a Route 53 alias record when you
|
730
743
|
# register an instance, specify `A` or `AAAA` for `Type`.
|
731
744
|
#
|
732
|
-
# You specify other settings, such as the IP address for A and
|
733
|
-
# records, when you register an instance. For more information,
|
734
|
-
# [RegisterInstance][1].
|
745
|
+
# You specify other settings, such as the IP address for `A` and
|
746
|
+
# `AAAA` records, when you register an instance. For more information,
|
747
|
+
# see [RegisterInstance][1].
|
735
748
|
#
|
736
749
|
# The following values are supported:
|
737
750
|
#
|
738
|
-
#
|
739
|
-
#
|
740
|
-
#
|
741
|
-
# as
|
742
|
-
#
|
743
|
-
#
|
744
|
-
#
|
745
|
-
#
|
746
|
-
#
|
747
|
-
#
|
748
|
-
#
|
749
|
-
#
|
750
|
-
#
|
751
|
-
#
|
752
|
-
#
|
753
|
-
#
|
754
|
-
#
|
755
|
-
#
|
756
|
-
#
|
757
|
-
#
|
758
|
-
#
|
759
|
-
#
|
760
|
-
#
|
761
|
-
#
|
762
|
-
#
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
766
|
-
#
|
767
|
-
#
|
768
|
-
#
|
769
|
-
#
|
770
|
-
#
|
771
|
-
#
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
790
|
-
# the service is `backend`, and the name of the namespace is
|
791
|
-
# `example.com`, the value of `service-hostname` is:
|
792
|
-
#
|
793
|
-
# `test.backend.example.com`
|
794
|
-
#
|
795
|
-
# If you specify settings for an SRV record, note the following:
|
796
|
-
#
|
797
|
-
# * If you specify values for `AWS_INSTANCE_IPV4`,
|
798
|
-
# `AWS_INSTANCE_IPV6`, or both in the `RegisterInstance` request,
|
799
|
-
# AWS Cloud Map automatically creates `A` and/or `AAAA` records that
|
800
|
-
# have the same name as the value of `service-hostname` in the SRV
|
801
|
-
# record. You can ignore these records.
|
802
|
-
#
|
803
|
-
# * If you're using a system that requires a specific SRV format,
|
804
|
-
# such as HAProxy, see the [Name][3] element in the documentation
|
805
|
-
# about `CreateService` for information about how to specify the
|
806
|
-
# correct name format.
|
751
|
+
# `A` <b> <code> </b> </p> <p>Route 53 returns the IP address of the
|
752
|
+
# resource in IPv4 format, such as 192.0.2.44.</p> <p>
|
753
|
+
# <code>AAAA</code> <b> <code> </b> </p> <p>Route 53 returns the IP
|
754
|
+
# address of the resource in IPv6 format, such as
|
755
|
+
# 2001:0db8:85a3:0000:0000:abcd:0001:2345.</p> <p> <code>CNAME</code>
|
756
|
+
# <b> <code> </b> </p> <p>Route 53 returns the domain name of the
|
757
|
+
# resource, such as www.example.com. Note the following:</p> <ul> <li>
|
758
|
+
# <p>You specify the domain name that you want to route traffic to
|
759
|
+
# when you register an instance. For more information, see <a
|
760
|
+
# href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes">Attributes</a>
|
761
|
+
# in the topic <a
|
762
|
+
# href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a>.</p>
|
763
|
+
# </li> <li> <p>You must specify <code>WEIGHTED</code> for the value
|
764
|
+
# of <code>RoutingPolicy</code>.</p> </li> <li> <p>You can't specify
|
765
|
+
# both <code>CNAME</code> for <code>Type</code> and settings for
|
766
|
+
# <code>HealthCheckConfig</code>. If you do, the request will fail
|
767
|
+
# with an <code>InvalidInput</code> error.</p> </li> </ul> <p>
|
768
|
+
# <b>SRV</b> </p> <p>Route 53 returns the value for an
|
769
|
+
# <code>SRV</code> record. The value for an <code>SRV</code> record
|
770
|
+
# uses the following values:</p> <p> <code>priority weight port
|
771
|
+
# service-hostname</code> </p> <p>Note the following about the
|
772
|
+
# values:</p> <ul> <li> <p>The values of <code>priority</code> and
|
773
|
+
# <code>weight</code> are both set to <code>1</code> and can't be
|
774
|
+
# changed. </p> </li> <li> <p>The value of <code>port</code> comes
|
775
|
+
# from the value that you specify for the
|
776
|
+
# <code>AWS_INSTANCE_PORT</code> attribute when you submit a <a
|
777
|
+
# href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a>
|
778
|
+
# request. </p> </li> <li> <p>The value of
|
779
|
+
# <code>service-hostname</code> is a concatenation of the following
|
780
|
+
# values:</p> <ul> <li> <p>The value that you specify for
|
781
|
+
# <code>InstanceId</code> when you register an instance.</p> </li>
|
782
|
+
# <li> <p>The name of the service.</p> </li> <li> <p>The name of the
|
783
|
+
# namespace. </p> </li> </ul> <p>For example, if the value of
|
784
|
+
# <code>InstanceId</code> is <code>test</code>, the name of the
|
785
|
+
# service is <code>backend</code>, and the name of the namespace is
|
786
|
+
# <code>example.com</code>, the value of <code>service-hostname</code>
|
787
|
+
# is:</p> <p> <code>test.backend.example.com</code> </p> </li> </ul>
|
788
|
+
# <p>If you specify settings for an <code>SRV</code> record, note the
|
789
|
+
# following:</p> <ul> <li> <p>If you specify values for
|
790
|
+
# <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or
|
791
|
+
# both in the <code>RegisterInstance</code> request, AWS Cloud Map
|
792
|
+
# automatically creates <code>A</code> and/or <code>AAAA</code>
|
793
|
+
# records that have the same name as the value of
|
794
|
+
# <code>service-hostname</code> in the <code>SRV</code> record. You
|
795
|
+
# can ignore these records.</p> </li> <li> <p>If you're using a system
|
796
|
+
# that requires a specific <code>SRV</code> format, such as HAProxy,
|
797
|
+
# see the <a
|
798
|
+
# href="https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name">Name</a>
|
799
|
+
# element in the documentation about <code>CreateService</code> for
|
800
|
+
# information about how to specify the correct name format.</p> </li>
|
801
|
+
# </ul>
|
802
|
+
# </code></b></p></code></b></p></code></b>
|
807
803
|
#
|
808
804
|
#
|
809
805
|
#
|
810
806
|
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
|
811
|
-
# [2]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes
|
812
|
-
# [3]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name
|
813
807
|
# @return [String]
|
814
808
|
#
|
815
809
|
# @!attribute [rw] ttl
|
816
810
|
# The amount of time, in seconds, that you want DNS resolvers to cache
|
817
811
|
# the settings for this record.
|
818
812
|
#
|
819
|
-
# <note markdown="1"> Alias records don't include a TTL because Route
|
813
|
+
# <note markdown="1"> Alias records don't include a TTL because Route 53 uses the TTL for
|
820
814
|
# the AWS resource that an alias record routes traffic to. If you
|
821
815
|
# include the `AWS_ALIAS_DNS_NAME` attribute when you submit a
|
822
816
|
# [RegisterInstance][1] request, the `TTL` value is ignored. Always
|
@@ -1076,21 +1070,21 @@ module Aws::ServiceDiscovery
|
|
1076
1070
|
# If you specify a health check configuration, you can specify either
|
1077
1071
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
1078
1072
|
#
|
1079
|
-
# Health checks are basic Route
|
1073
|
+
# Health checks are basic Route 53 health checks that monitor an AWS
|
1080
1074
|
# endpoint. For information about pricing for health checks, see [Amazon
|
1081
|
-
# Route
|
1075
|
+
# Route 53 Pricing][1].
|
1082
1076
|
#
|
1083
1077
|
# Note the following about configuring health checks.
|
1084
1078
|
#
|
1085
|
-
#
|
1079
|
+
# <b> <code>A</code> and <code>AAAA</code> records</b>
|
1086
1080
|
#
|
1087
|
-
# If `DnsConfig` includes configurations for both A and AAAA
|
1088
|
-
# AWS Cloud Map creates a health check that uses the IPv4
|
1089
|
-
# check the health of the resource. If the endpoint that is
|
1090
|
-
# the IPv4 address is unhealthy, Route
|
1091
|
-
# records to be unhealthy.
|
1081
|
+
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
1082
|
+
# records, AWS Cloud Map creates a health check that uses the IPv4
|
1083
|
+
# address to check the health of the resource. If the endpoint that is
|
1084
|
+
# specified by the IPv4 address is unhealthy, Route 53 considers both
|
1085
|
+
# the `A` and `AAAA` records to be unhealthy.
|
1092
1086
|
#
|
1093
|
-
#
|
1087
|
+
# <b> <code>CNAME</code> records</b>
|
1094
1088
|
#
|
1095
1089
|
# You can't specify settings for `HealthCheckConfig` when the
|
1096
1090
|
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
@@ -1098,7 +1092,7 @@ module Aws::ServiceDiscovery
|
|
1098
1092
|
#
|
1099
1093
|
# **Request interval**
|
1100
1094
|
#
|
1101
|
-
# A Route
|
1095
|
+
# A Route 53 health checker in each health-checking region sends a
|
1102
1096
|
# health check request to an endpoint every 30 seconds. On average, your
|
1103
1097
|
# endpoint receives a health check request about every two seconds.
|
1104
1098
|
# However, health checkers don't coordinate with one another, so
|
@@ -1107,29 +1101,29 @@ module Aws::ServiceDiscovery
|
|
1107
1101
|
#
|
1108
1102
|
# **Health checking regions**
|
1109
1103
|
#
|
1110
|
-
# Health checkers perform checks from all Route
|
1104
|
+
# Health checkers perform checks from all Route 53 health-checking
|
1111
1105
|
# regions. For a list of the current regions, see [Regions][2].
|
1112
1106
|
#
|
1113
1107
|
# **Alias records**
|
1114
1108
|
#
|
1115
1109
|
# When you register an instance, if you include the `AWS_ALIAS_DNS_NAME`
|
1116
|
-
# attribute, AWS Cloud Map creates a Route
|
1110
|
+
# attribute, AWS Cloud Map creates a Route 53 alias record. Note the
|
1117
1111
|
# following:
|
1118
1112
|
#
|
1119
|
-
# * Route
|
1113
|
+
# * Route 53 automatically sets `EvaluateTargetHealth` to true for alias
|
1120
1114
|
# records. When `EvaluateTargetHealth` is true, the alias record
|
1121
1115
|
# inherits the health of the referenced AWS resource. such as an ELB
|
1122
1116
|
# load balancer. For more information, see [EvaluateTargetHealth][3].
|
1123
1117
|
#
|
1124
1118
|
# * If you include `HealthCheckConfig` and then use the service to
|
1125
|
-
# register an instance that creates an alias record, Route
|
1119
|
+
# register an instance that creates an alias record, Route 53 doesn't
|
1126
1120
|
# create the health check.
|
1127
1121
|
#
|
1128
1122
|
# **Charges for health checks**
|
1129
1123
|
#
|
1130
|
-
# Health checks are basic Route
|
1124
|
+
# Health checks are basic Route 53 health checks that monitor an AWS
|
1131
1125
|
# endpoint. For information about pricing for health checks, see [Amazon
|
1132
|
-
# Route
|
1126
|
+
# Route 53 Pricing][1].
|
1133
1127
|
#
|
1134
1128
|
#
|
1135
1129
|
#
|
@@ -1148,31 +1142,31 @@ module Aws::ServiceDiscovery
|
|
1148
1142
|
#
|
1149
1143
|
# @!attribute [rw] type
|
1150
1144
|
# The type of health check that you want to create, which indicates
|
1151
|
-
# how Route
|
1145
|
+
# how Route 53 determines whether an endpoint is healthy.
|
1152
1146
|
#
|
1153
1147
|
# You can't change the value of `Type` after you create a health
|
1154
1148
|
# check.
|
1155
1149
|
#
|
1156
1150
|
# You can create the following types of health checks:
|
1157
1151
|
#
|
1158
|
-
# * **HTTP**\: Route
|
1159
|
-
# successful, Route
|
1152
|
+
# * **HTTP**\: Route 53 tries to establish a TCP connection. If
|
1153
|
+
# successful, Route 53 submits an HTTP request and waits for an HTTP
|
1160
1154
|
# status code of 200 or greater and less than 400.
|
1161
1155
|
#
|
1162
|
-
# * **HTTPS**\: Route
|
1163
|
-
# successful, Route
|
1156
|
+
# * **HTTPS**\: Route 53 tries to establish a TCP connection. If
|
1157
|
+
# successful, Route 53 submits an HTTPS request and waits for an
|
1164
1158
|
# HTTP status code of 200 or greater and less than 400.
|
1165
1159
|
#
|
1166
1160
|
# If you specify HTTPS for the value of `Type`, the endpoint must
|
1167
1161
|
# support TLS v1.0 or later.
|
1168
1162
|
#
|
1169
|
-
# * **TCP**\: Route
|
1163
|
+
# * **TCP**\: Route 53 tries to establish a TCP connection.
|
1170
1164
|
#
|
1171
1165
|
# If you specify `TCP` for `Type`, don't specify a value for
|
1172
1166
|
# `ResourcePath`.
|
1173
1167
|
#
|
1174
|
-
# For more information, see [How Route
|
1175
|
-
# Endpoint Is Healthy][1] in the *Route
|
1168
|
+
# For more information, see [How Route 53 Determines Whether an
|
1169
|
+
# Endpoint Is Healthy][1] in the *Route 53 Developer Guide*.
|
1176
1170
|
#
|
1177
1171
|
#
|
1178
1172
|
#
|
@@ -1180,12 +1174,12 @@ module Aws::ServiceDiscovery
|
|
1180
1174
|
# @return [String]
|
1181
1175
|
#
|
1182
1176
|
# @!attribute [rw] resource_path
|
1183
|
-
# The path that you want Route
|
1177
|
+
# The path that you want Route 53 to request when performing health
|
1184
1178
|
# checks. The path can be any value for which your endpoint will
|
1185
1179
|
# return an HTTP status code of 2xx or 3xx when the endpoint is
|
1186
|
-
# healthy, such as the file `/docs/route53-health-check.html`.
|
1187
|
-
# 53 automatically adds the DNS name for the service. If you
|
1188
|
-
# specify a value for `ResourcePath`, the default value is `/`.
|
1180
|
+
# healthy, such as the file `/docs/route53-health-check.html`.
|
1181
|
+
# Route 53 automatically adds the DNS name for the service. If you
|
1182
|
+
# don't specify a value for `ResourcePath`, the default value is `/`.
|
1189
1183
|
#
|
1190
1184
|
# If you specify `TCP` for `Type`, you must *not* specify a value for
|
1191
1185
|
# `ResourcePath`.
|
@@ -1193,10 +1187,10 @@ module Aws::ServiceDiscovery
|
|
1193
1187
|
#
|
1194
1188
|
# @!attribute [rw] failure_threshold
|
1195
1189
|
# The number of consecutive health checks that an endpoint must pass
|
1196
|
-
# or fail for Route
|
1190
|
+
# or fail for Route 53 to change the current status of the endpoint
|
1197
1191
|
# from unhealthy to healthy or vice versa. For more information, see
|
1198
|
-
# [How Route
|
1199
|
-
# *Route
|
1192
|
+
# [How Route 53 Determines Whether an Endpoint Is Healthy][1] in the
|
1193
|
+
# *Route 53 Developer Guide*.
|
1200
1194
|
#
|
1201
1195
|
#
|
1202
1196
|
#
|
@@ -1279,20 +1273,19 @@ module Aws::ServiceDiscovery
|
|
1279
1273
|
# }
|
1280
1274
|
#
|
1281
1275
|
# @!attribute [rw] failure_threshold
|
1276
|
+
# This parameter has been deprecated and is always set to 1. AWS Cloud
|
1277
|
+
# Map waits for approximately 30 seconds after receiving an
|
1278
|
+
# `UpdateInstanceCustomHealthStatus` request before changing the
|
1279
|
+
# status of the service instance.
|
1280
|
+
#
|
1282
1281
|
# The number of 30-second intervals that you want AWS Cloud Map to
|
1283
1282
|
# wait after receiving an `UpdateInstanceCustomHealthStatus` request
|
1284
|
-
# before it changes the health status of a service instance.
|
1285
|
-
# example, suppose you specify a value of `2` for `FailureTheshold`,
|
1286
|
-
# and then your application sends an
|
1287
|
-
# `UpdateInstanceCustomHealthStatus` request. AWS Cloud Map waits for
|
1288
|
-
# approximately 60 seconds (2 x 30) before changing the status of the
|
1289
|
-
# service instance based on that request.
|
1283
|
+
# before it changes the health status of a service instance.
|
1290
1284
|
#
|
1291
1285
|
# Sending a second or subsequent `UpdateInstanceCustomHealthStatus`
|
1292
|
-
# request with the same value before
|
1293
|
-
#
|
1294
|
-
#
|
1295
|
-
# change.
|
1286
|
+
# request with the same value before 30 seconds has passed doesn't
|
1287
|
+
# accelerate the change. AWS Cloud Map still waits `30` seconds after
|
1288
|
+
# the first request to make the change.
|
1296
1289
|
# @return [Integer]
|
1297
1290
|
#
|
1298
1291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/HealthCheckCustomConfig AWS API Documentation
|
@@ -1370,8 +1363,8 @@ module Aws::ServiceDiscovery
|
|
1370
1363
|
# following:
|
1371
1364
|
#
|
1372
1365
|
# * If the service that is specified by `ServiceId` includes settings
|
1373
|
-
# for an SRV record, the value of `InstanceId` is automatically
|
1374
|
-
# included as part of the value for the SRV record. For more
|
1366
|
+
# for an `SRV` record, the value of `InstanceId` is automatically
|
1367
|
+
# included as part of the value for the `SRV` record. For more
|
1375
1368
|
# information, see [DnsRecord > Type][1].
|
1376
1369
|
#
|
1377
1370
|
# * You can use this value to update an existing instance.
|
@@ -1421,7 +1414,7 @@ module Aws::ServiceDiscovery
|
|
1421
1414
|
#
|
1422
1415
|
# ****
|
1423
1416
|
#
|
1424
|
-
# If you want AWS Cloud Map to create a Route
|
1417
|
+
# If you want AWS Cloud Map to create a Route 53 alias record that
|
1425
1418
|
# routes traffic to an Elastic Load Balancing load balancer, specify
|
1426
1419
|
# the DNS name that is associated with the load balancer. For
|
1427
1420
|
# information about how to get the DNS name, see "DNSName" in the
|
@@ -1430,7 +1423,8 @@ module Aws::ServiceDiscovery
|
|
1430
1423
|
# Note the following:
|
1431
1424
|
#
|
1432
1425
|
# * The configuration for the service that is specified by `ServiceId`
|
1433
|
-
# must include settings for an A record, an AAAA record, or
|
1426
|
+
# must include settings for an `A` record, an `AAAA` record, or
|
1427
|
+
# both.
|
1434
1428
|
#
|
1435
1429
|
# * In the service that is specified by `ServiceId`, the value of
|
1436
1430
|
# `RoutingPolicy` must be `WEIGHTED`.
|
@@ -1446,47 +1440,53 @@ module Aws::ServiceDiscovery
|
|
1446
1440
|
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
1447
1441
|
# values for any of the `AWS_INSTANCE` attributes.
|
1448
1442
|
#
|
1443
|
+
# **AWS\_EC2\_INSTANCE\_ID**
|
1444
|
+
#
|
1445
|
+
# *HTTP namespaces only.* The Amazon EC2 instance ID for the instance.
|
1446
|
+
# The `AWS_INSTANCE_IPV4` attribute contains the primary private IPv4
|
1447
|
+
# address.
|
1448
|
+
#
|
1449
1449
|
# **AWS\_INSTANCE\_CNAME**
|
1450
1450
|
#
|
1451
|
-
# If the service configuration includes a CNAME record, the domain
|
1452
|
-
# name that you want Route
|
1451
|
+
# If the service configuration includes a `CNAME` record, the domain
|
1452
|
+
# name that you want Route 53 to return in response to DNS queries,
|
1453
1453
|
# for example, `example.com`.
|
1454
1454
|
#
|
1455
1455
|
# This value is required if the service specified by `ServiceId`
|
1456
|
-
# includes settings for an CNAME record.
|
1456
|
+
# includes settings for an `CNAME` record.
|
1457
1457
|
#
|
1458
1458
|
# **AWS\_INSTANCE\_IPV4**
|
1459
1459
|
#
|
1460
|
-
# If the service configuration includes an A record, the IPv4
|
1461
|
-
# that you want Route
|
1462
|
-
# example, `192.0.2.44`.
|
1460
|
+
# If the service configuration includes an `A` record, the IPv4
|
1461
|
+
# address that you want Route 53 to return in response to DNS queries,
|
1462
|
+
# for example, `192.0.2.44`.
|
1463
1463
|
#
|
1464
1464
|
# This value is required if the service specified by `ServiceId`
|
1465
|
-
# includes settings for an A record. If the service includes
|
1466
|
-
# for an SRV record, you must specify a value for
|
1467
|
-
# `AWS_INSTANCE_IPV6`, or both.
|
1465
|
+
# includes settings for an `A` record. If the service includes
|
1466
|
+
# settings for an `SRV` record, you must specify a value for
|
1467
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1468
1468
|
#
|
1469
1469
|
# **AWS\_INSTANCE\_IPV6**
|
1470
1470
|
#
|
1471
|
-
# If the service configuration includes an AAAA record, the IPv6
|
1472
|
-
# address that you want Route
|
1471
|
+
# If the service configuration includes an `AAAA` record, the IPv6
|
1472
|
+
# address that you want Route 53 to return in response to DNS queries,
|
1473
1473
|
# for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
1474
1474
|
#
|
1475
1475
|
# This value is required if the service specified by `ServiceId`
|
1476
|
-
# includes settings for an AAAA record. If the service includes
|
1477
|
-
# settings for an SRV record, you must specify a value for
|
1476
|
+
# includes settings for an `AAAA` record. If the service includes
|
1477
|
+
# settings for an `SRV` record, you must specify a value for
|
1478
1478
|
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1479
1479
|
#
|
1480
1480
|
# **AWS\_INSTANCE\_PORT**
|
1481
1481
|
#
|
1482
|
-
# If the service includes an SRV record, the value that you want
|
1483
|
-
# 53 to return for the port.
|
1482
|
+
# If the service includes an `SRV` record, the value that you want
|
1483
|
+
# Route 53 to return for the port.
|
1484
1484
|
#
|
1485
1485
|
# If the service includes `HealthCheckConfig`, the port on the
|
1486
|
-
# endpoint that you want Route
|
1486
|
+
# endpoint that you want Route 53 to send requests to.
|
1487
1487
|
#
|
1488
|
-
# This value is required if you specified settings for an SRV record
|
1489
|
-
# or a Route
|
1488
|
+
# This value is required if you specified settings for an `SRV` record
|
1489
|
+
# or a Route 53 health check when you created the service.
|
1490
1490
|
#
|
1491
1491
|
#
|
1492
1492
|
#
|
@@ -1538,20 +1538,26 @@ module Aws::ServiceDiscovery
|
|
1538
1538
|
# an Elastic Load Balancing load balancer, the DNS name that is
|
1539
1539
|
# associated with the load balancer.
|
1540
1540
|
#
|
1541
|
-
# * `
|
1542
|
-
#
|
1541
|
+
# * `AWS_EC2_INSTANCE_ID`\: (HTTP namespaces only) The Amazon EC2
|
1542
|
+
# instance ID for the instance. When the `AWS_EC2_INSTANCE_ID`
|
1543
|
+
# attribute is specified, then the `AWS_INSTANCE_IPV4` attribute
|
1544
|
+
# contains the primary private IPv4 address.
|
1545
|
+
#
|
1546
|
+
# * `AWS_INSTANCE_CNAME`\: For a `CNAME` record, the domain name that
|
1547
|
+
# Route 53 returns in response to DNS queries, for example,
|
1543
1548
|
# `example.com`.
|
1544
1549
|
#
|
1545
|
-
# * `AWS_INSTANCE_IPV4`\: For an A record, the IPv4 address that
|
1546
|
-
# 53 returns in response to DNS queries, for example,
|
1550
|
+
# * `AWS_INSTANCE_IPV4`\: For an `A` record, the IPv4 address that
|
1551
|
+
# Route 53 returns in response to DNS queries, for example,
|
1552
|
+
# `192.0.2.44`.
|
1547
1553
|
#
|
1548
|
-
# * `AWS_INSTANCE_IPV6`\: For an AAAA record, the IPv6 address that
|
1549
|
-
# Route
|
1554
|
+
# * `AWS_INSTANCE_IPV6`\: For an `AAAA` record, the IPv6 address that
|
1555
|
+
# Route 53 returns in response to DNS queries, for example,
|
1550
1556
|
# `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
1551
1557
|
#
|
1552
|
-
# * `AWS_INSTANCE_PORT`\: For an SRV record, the value that Route
|
1558
|
+
# * `AWS_INSTANCE_PORT`\: For an `SRV` record, the value that Route 53
|
1553
1559
|
# returns for the port. In addition, if the service includes
|
1554
|
-
# `HealthCheckConfig`, the port on the endpoint that Route
|
1560
|
+
# `HealthCheckConfig`, the port on the endpoint that Route 53 sends
|
1555
1561
|
# requests to.
|
1556
1562
|
# @return [Hash<String,String>]
|
1557
1563
|
#
|
@@ -2087,7 +2093,7 @@ module Aws::ServiceDiscovery
|
|
2087
2093
|
# namespace type.
|
2088
2094
|
#
|
2089
2095
|
# @!attribute [rw] dns_properties
|
2090
|
-
# A complex type that contains the ID for the Route
|
2096
|
+
# A complex type that contains the ID for the Route 53 hosted zone
|
2091
2097
|
# that AWS Cloud Map creates when you create a namespace.
|
2092
2098
|
# @return [Types::DnsProperties]
|
2093
2099
|
#
|
@@ -2117,7 +2123,7 @@ module Aws::ServiceDiscovery
|
|
2117
2123
|
#
|
2118
2124
|
# @!attribute [rw] name
|
2119
2125
|
# The name of the namespace. When you create a namespace, AWS Cloud
|
2120
|
-
# Map automatically creates a Route
|
2126
|
+
# Map automatically creates a Route 53 hosted zone that has the same
|
2121
2127
|
# name as the namespace.
|
2122
2128
|
# @return [String]
|
2123
2129
|
#
|
@@ -2397,8 +2403,8 @@ module Aws::ServiceDiscovery
|
|
2397
2403
|
# following:
|
2398
2404
|
#
|
2399
2405
|
# * If the service that is specified by `ServiceId` includes settings
|
2400
|
-
# for an SRV record, the value of `InstanceId` is automatically
|
2401
|
-
# included as part of the value for the SRV record. For more
|
2406
|
+
# for an `SRV` record, the value of `InstanceId` is automatically
|
2407
|
+
# included as part of the value for the `SRV` record. For more
|
2402
2408
|
# information, see [DnsRecord > Type][1].
|
2403
2409
|
#
|
2404
2410
|
# * You can use this value to update an existing instance.
|
@@ -2449,33 +2455,42 @@ module Aws::ServiceDiscovery
|
|
2449
2455
|
#
|
2450
2456
|
# **AWS\_ALIAS\_DNS\_NAME**
|
2451
2457
|
#
|
2452
|
-
#
|
2453
|
-
#
|
2454
|
-
# If you want AWS Cloud Map to create an Amazon Route 53 alias record
|
2458
|
+
# If you want AWS Cloud Map to create an Amazon Route 53 alias record
|
2455
2459
|
# that routes traffic to an Elastic Load Balancing load balancer,
|
2456
2460
|
# specify the DNS name that is associated with the load balancer. For
|
2457
2461
|
# information about how to get the DNS name, see "DNSName" in the
|
2458
|
-
# topic [AliasTarget][1] in the *Route
|
2462
|
+
# topic [AliasTarget][1] in the *Route 53 API Reference*.
|
2459
2463
|
#
|
2460
2464
|
# Note the following:
|
2461
2465
|
#
|
2462
2466
|
# * The configuration for the service that is specified by `ServiceId`
|
2463
|
-
# must include settings for an A record, an AAAA record, or
|
2467
|
+
# must include settings for an `A` record, an `AAAA` record, or
|
2468
|
+
# both.
|
2464
2469
|
#
|
2465
2470
|
# * In the service that is specified by `ServiceId`, the value of
|
2466
2471
|
# `RoutingPolicy` must be `WEIGHTED`.
|
2467
2472
|
#
|
2468
2473
|
# * If the service that is specified by `ServiceId` includes
|
2469
|
-
# `HealthCheckConfig` settings, AWS Cloud Map will create the
|
2470
|
-
# 53 health check, but it won't associate the health check
|
2471
|
-
# alias record.
|
2474
|
+
# `HealthCheckConfig` settings, AWS Cloud Map will create the
|
2475
|
+
# Route 53 health check, but it won't associate the health check
|
2476
|
+
# with the alias record.
|
2472
2477
|
#
|
2473
2478
|
# * Auto naming currently doesn't support creating alias records that
|
2474
|
-
# route traffic to AWS resources other than
|
2479
|
+
# route traffic to AWS resources other than Elastic Load Balancing
|
2480
|
+
# load balancers.
|
2475
2481
|
#
|
2476
2482
|
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
2477
2483
|
# values for any of the `AWS_INSTANCE` attributes.
|
2478
2484
|
#
|
2485
|
+
# **AWS\_EC2\_INSTANCE\_ID**
|
2486
|
+
#
|
2487
|
+
# *HTTP namespaces only.* The Amazon EC2 instance ID for the instance.
|
2488
|
+
# If the `AWS_EC2_INSTANCE_ID` attribute is specified, then the only
|
2489
|
+
# other attribute that can be specified is `AWS_INIT_HEALTH_STATUS`.
|
2490
|
+
# When the `AWS_EC2_INSTANCE_ID` attribute is specified, then the
|
2491
|
+
# `AWS_INSTANCE_IPV4` attribute will be filled out with the primary
|
2492
|
+
# private IPv4 address.
|
2493
|
+
#
|
2479
2494
|
# **AWS\_INIT\_HEALTH\_STATUS**
|
2480
2495
|
#
|
2481
2496
|
# If the service configuration includes `HealthCheckCustomConfig`, you
|
@@ -2486,51 +2501,51 @@ module Aws::ServiceDiscovery
|
|
2486
2501
|
#
|
2487
2502
|
# **AWS\_INSTANCE\_CNAME**
|
2488
2503
|
#
|
2489
|
-
# If the service configuration includes a CNAME record, the domain
|
2490
|
-
# name that you want Route
|
2504
|
+
# If the service configuration includes a `CNAME` record, the domain
|
2505
|
+
# name that you want Route 53 to return in response to DNS queries,
|
2491
2506
|
# for example, `example.com`.
|
2492
2507
|
#
|
2493
2508
|
# This value is required if the service specified by `ServiceId`
|
2494
|
-
# includes settings for an CNAME record.
|
2509
|
+
# includes settings for an `CNAME` record.
|
2495
2510
|
#
|
2496
2511
|
# **AWS\_INSTANCE\_IPV4**
|
2497
2512
|
#
|
2498
|
-
# If the service configuration includes an A record, the IPv4
|
2499
|
-
# that you want Route
|
2500
|
-
# example, `192.0.2.44`.
|
2513
|
+
# If the service configuration includes an `A` record, the IPv4
|
2514
|
+
# address that you want Route 53 to return in response to DNS queries,
|
2515
|
+
# for example, `192.0.2.44`.
|
2501
2516
|
#
|
2502
2517
|
# This value is required if the service specified by `ServiceId`
|
2503
|
-
# includes settings for an A record. If the service includes
|
2504
|
-
# for an SRV record, you must specify a value for
|
2505
|
-
# `AWS_INSTANCE_IPV6`, or both.
|
2518
|
+
# includes settings for an `A` record. If the service includes
|
2519
|
+
# settings for an `SRV` record, you must specify a value for
|
2520
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
2506
2521
|
#
|
2507
2522
|
# **AWS\_INSTANCE\_IPV6**
|
2508
2523
|
#
|
2509
|
-
# If the service configuration includes an AAAA record, the IPv6
|
2510
|
-
# address that you want Route
|
2524
|
+
# If the service configuration includes an `AAAA` record, the IPv6
|
2525
|
+
# address that you want Route 53 to return in response to DNS queries,
|
2511
2526
|
# for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
2512
2527
|
#
|
2513
2528
|
# This value is required if the service specified by `ServiceId`
|
2514
|
-
# includes settings for an AAAA record. If the service includes
|
2515
|
-
# settings for an SRV record, you must specify a value for
|
2529
|
+
# includes settings for an `AAAA` record. If the service includes
|
2530
|
+
# settings for an `SRV` record, you must specify a value for
|
2516
2531
|
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
2517
2532
|
#
|
2518
2533
|
# **AWS\_INSTANCE\_PORT**
|
2519
2534
|
#
|
2520
|
-
# If the service includes an SRV record, the value that you want
|
2521
|
-
# 53 to return for the port.
|
2535
|
+
# If the service includes an `SRV` record, the value that you want
|
2536
|
+
# Route 53 to return for the port.
|
2522
2537
|
#
|
2523
2538
|
# If the service includes `HealthCheckConfig`, the port on the
|
2524
|
-
# endpoint that you want Route
|
2539
|
+
# endpoint that you want Route 53 to send requests to.
|
2525
2540
|
#
|
2526
|
-
# This value is required if you specified settings for an SRV record
|
2527
|
-
# or a Route
|
2541
|
+
# This value is required if you specified settings for an `SRV` record
|
2542
|
+
# or a Route 53 health check when you created the service.
|
2528
2543
|
#
|
2529
2544
|
# **Custom attributes**
|
2530
2545
|
#
|
2531
2546
|
# You can add up to 30 custom attributes. For each key-value pair, the
|
2532
2547
|
# maximum length of the attribute name is 255 characters, and the
|
2533
|
-
# maximum length of the attribute value is 1,024 characters.
|
2548
|
+
# maximum length of the attribute value is 1,024 characters. The total
|
2534
2549
|
# size of all provided attributes (sum of all keys and values) must
|
2535
2550
|
# not exceed 5,000 characters.
|
2536
2551
|
#
|
@@ -2568,8 +2583,14 @@ module Aws::ServiceDiscovery
|
|
2568
2583
|
include Aws::Structure
|
2569
2584
|
end
|
2570
2585
|
|
2571
|
-
# The operation can't be completed because you've reached the
|
2572
|
-
# the number of requests.
|
2586
|
+
# The operation can't be completed because you've reached the quota
|
2587
|
+
# for the number of requests. For more information, see [AWS Cloud Map
|
2588
|
+
# API request throttling quota][1] in the *AWS Cloud Map Developer
|
2589
|
+
# Guide*.
|
2590
|
+
#
|
2591
|
+
#
|
2592
|
+
#
|
2593
|
+
# [1]: https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html
|
2573
2594
|
#
|
2574
2595
|
# @!attribute [rw] message
|
2575
2596
|
# @return [String]
|
@@ -2597,7 +2618,7 @@ module Aws::ServiceDiscovery
|
|
2597
2618
|
include Aws::Structure
|
2598
2619
|
end
|
2599
2620
|
|
2600
|
-
# The resource can't be created because you've reached the
|
2621
|
+
# The resource can't be created because you've reached the quota on
|
2601
2622
|
# the number of resources.
|
2602
2623
|
#
|
2603
2624
|
# @!attribute [rw] message
|
@@ -2656,7 +2677,7 @@ module Aws::ServiceDiscovery
|
|
2656
2677
|
# @return [Integer]
|
2657
2678
|
#
|
2658
2679
|
# @!attribute [rw] dns_config
|
2659
|
-
# A complex type that contains information about the Route
|
2680
|
+
# A complex type that contains information about the Route 53 DNS
|
2660
2681
|
# records that you want AWS Cloud Map to create when you register an
|
2661
2682
|
# instance.
|
2662
2683
|
# @return [Types::DnsConfig]
|
@@ -2668,7 +2689,7 @@ module Aws::ServiceDiscovery
|
|
2668
2689
|
# records that you specify in `DnsConfig`.
|
2669
2690
|
#
|
2670
2691
|
# For information about the charges for health checks, see [Amazon
|
2671
|
-
# Route
|
2692
|
+
# Route 53 Pricing][1].
|
2672
2693
|
#
|
2673
2694
|
#
|
2674
2695
|
#
|
@@ -2766,7 +2787,7 @@ module Aws::ServiceDiscovery
|
|
2766
2787
|
# @return [String]
|
2767
2788
|
#
|
2768
2789
|
# @!attribute [rw] dns_config
|
2769
|
-
# A complex type that contains information about the Route
|
2790
|
+
# A complex type that contains information about the Route 53 DNS
|
2770
2791
|
# records that you want AWS Cloud Map to create when you register an
|
2771
2792
|
# instance.
|
2772
2793
|
# @return [Types::DnsConfigChange]
|
@@ -2780,21 +2801,21 @@ module Aws::ServiceDiscovery
|
|
2780
2801
|
# If you specify a health check configuration, you can specify either
|
2781
2802
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
2782
2803
|
#
|
2783
|
-
# Health checks are basic Route
|
2804
|
+
# Health checks are basic Route 53 health checks that monitor an AWS
|
2784
2805
|
# endpoint. For information about pricing for health checks, see
|
2785
|
-
# [Amazon Route
|
2806
|
+
# [Amazon Route 53 Pricing][1].
|
2786
2807
|
#
|
2787
2808
|
# Note the following about configuring health checks.
|
2788
2809
|
#
|
2789
|
-
#
|
2810
|
+
# <b> <code>A</code> and <code>AAAA</code> records</b>
|
2790
2811
|
#
|
2791
|
-
# If `DnsConfig` includes configurations for both A and AAAA
|
2792
|
-
# AWS Cloud Map creates a health check that uses the IPv4
|
2793
|
-
# check the health of the resource. If the endpoint that is
|
2794
|
-
# by the IPv4 address is unhealthy, Route
|
2795
|
-
# AAAA records to be unhealthy.
|
2812
|
+
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
2813
|
+
# records, AWS Cloud Map creates a health check that uses the IPv4
|
2814
|
+
# address to check the health of the resource. If the endpoint that is
|
2815
|
+
# specified by the IPv4 address is unhealthy, Route 53 considers both
|
2816
|
+
# the `A` and `AAAA` records to be unhealthy.
|
2796
2817
|
#
|
2797
|
-
#
|
2818
|
+
# <b> <code>CNAME</code> records</b>
|
2798
2819
|
#
|
2799
2820
|
# You can't specify settings for `HealthCheckConfig` when the
|
2800
2821
|
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
@@ -2802,7 +2823,7 @@ module Aws::ServiceDiscovery
|
|
2802
2823
|
#
|
2803
2824
|
# **Request interval**
|
2804
2825
|
#
|
2805
|
-
# A Route
|
2826
|
+
# A Route 53 health checker in each health-checking region sends a
|
2806
2827
|
# health check request to an endpoint every 30 seconds. On average,
|
2807
2828
|
# your endpoint receives a health check request about every two
|
2808
2829
|
# seconds. However, health checkers don't coordinate with one
|
@@ -2811,30 +2832,30 @@ module Aws::ServiceDiscovery
|
|
2811
2832
|
#
|
2812
2833
|
# **Health checking regions**
|
2813
2834
|
#
|
2814
|
-
# Health checkers perform checks from all Route
|
2835
|
+
# Health checkers perform checks from all Route 53 health-checking
|
2815
2836
|
# regions. For a list of the current regions, see [Regions][2].
|
2816
2837
|
#
|
2817
2838
|
# **Alias records**
|
2818
2839
|
#
|
2819
2840
|
# When you register an instance, if you include the
|
2820
|
-
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route
|
2841
|
+
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route 53
|
2821
2842
|
# alias record. Note the following:
|
2822
2843
|
#
|
2823
|
-
# * Route
|
2844
|
+
# * Route 53 automatically sets `EvaluateTargetHealth` to true for
|
2824
2845
|
# alias records. When `EvaluateTargetHealth` is true, the alias
|
2825
2846
|
# record inherits the health of the referenced AWS resource. such as
|
2826
2847
|
# an ELB load balancer. For more information, see
|
2827
2848
|
# [EvaluateTargetHealth][3].
|
2828
2849
|
#
|
2829
2850
|
# * If you include `HealthCheckConfig` and then use the service to
|
2830
|
-
# register an instance that creates an alias record, Route
|
2851
|
+
# register an instance that creates an alias record, Route 53
|
2831
2852
|
# doesn't create the health check.
|
2832
2853
|
#
|
2833
2854
|
# **Charges for health checks**
|
2834
2855
|
#
|
2835
|
-
# Health checks are basic Route
|
2856
|
+
# Health checks are basic Route 53 health checks that monitor an AWS
|
2836
2857
|
# endpoint. For information about pricing for health checks, see
|
2837
|
-
# [Amazon Route
|
2858
|
+
# [Amazon Route 53 Pricing][1].
|
2838
2859
|
#
|
2839
2860
|
#
|
2840
2861
|
#
|
@@ -2940,7 +2961,7 @@ module Aws::ServiceDiscovery
|
|
2940
2961
|
# @return [Integer]
|
2941
2962
|
#
|
2942
2963
|
# @!attribute [rw] dns_config
|
2943
|
-
# A complex type that contains information about the Amazon Route
|
2964
|
+
# A complex type that contains information about the Amazon Route 53
|
2944
2965
|
# DNS records that you want AWS Cloud Map to create when you register
|
2945
2966
|
# an instance.
|
2946
2967
|
# @return [Types::DnsConfig]
|
@@ -2954,21 +2975,21 @@ module Aws::ServiceDiscovery
|
|
2954
2975
|
# If you specify a health check configuration, you can specify either
|
2955
2976
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
2956
2977
|
#
|
2957
|
-
# Health checks are basic Route
|
2978
|
+
# Health checks are basic Route 53 health checks that monitor an AWS
|
2958
2979
|
# endpoint. For information about pricing for health checks, see
|
2959
|
-
# [Amazon Route
|
2980
|
+
# [Amazon Route 53 Pricing][1].
|
2960
2981
|
#
|
2961
2982
|
# Note the following about configuring health checks.
|
2962
2983
|
#
|
2963
|
-
#
|
2984
|
+
# <b> <code>A</code> and <code>AAAA</code> records</b>
|
2964
2985
|
#
|
2965
|
-
# If `DnsConfig` includes configurations for both A and AAAA
|
2966
|
-
# AWS Cloud Map creates a health check that uses the IPv4
|
2967
|
-
# check the health of the resource. If the endpoint that is
|
2968
|
-
# by the IPv4 address is unhealthy, Route
|
2969
|
-
# AAAA records to be unhealthy.
|
2986
|
+
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
2987
|
+
# records, AWS Cloud Map creates a health check that uses the IPv4
|
2988
|
+
# address to check the health of the resource. If the endpoint that is
|
2989
|
+
# specified by the IPv4 address is unhealthy, Route 53 considers both
|
2990
|
+
# the `A` and `AAAA` records to be unhealthy.
|
2970
2991
|
#
|
2971
|
-
#
|
2992
|
+
# <b> <code>CNAME</code> records</b>
|
2972
2993
|
#
|
2973
2994
|
# You can't specify settings for `HealthCheckConfig` when the
|
2974
2995
|
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
@@ -2976,7 +2997,7 @@ module Aws::ServiceDiscovery
|
|
2976
2997
|
#
|
2977
2998
|
# **Request interval**
|
2978
2999
|
#
|
2979
|
-
# A Route
|
3000
|
+
# A Route 53 health checker in each health-checking region sends a
|
2980
3001
|
# health check request to an endpoint every 30 seconds. On average,
|
2981
3002
|
# your endpoint receives a health check request about every two
|
2982
3003
|
# seconds. However, health checkers don't coordinate with one
|
@@ -2985,30 +3006,30 @@ module Aws::ServiceDiscovery
|
|
2985
3006
|
#
|
2986
3007
|
# **Health checking regions**
|
2987
3008
|
#
|
2988
|
-
# Health checkers perform checks from all Route
|
3009
|
+
# Health checkers perform checks from all Route 53 health-checking
|
2989
3010
|
# regions. For a list of the current regions, see [Regions][2].
|
2990
3011
|
#
|
2991
3012
|
# **Alias records**
|
2992
3013
|
#
|
2993
3014
|
# When you register an instance, if you include the
|
2994
|
-
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route
|
3015
|
+
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route 53
|
2995
3016
|
# alias record. Note the following:
|
2996
3017
|
#
|
2997
|
-
# * Route
|
3018
|
+
# * Route 53 automatically sets `EvaluateTargetHealth` to true for
|
2998
3019
|
# alias records. When `EvaluateTargetHealth` is true, the alias
|
2999
3020
|
# record inherits the health of the referenced AWS resource. such as
|
3000
3021
|
# an ELB load balancer. For more information, see
|
3001
3022
|
# [EvaluateTargetHealth][3].
|
3002
3023
|
#
|
3003
3024
|
# * If you include `HealthCheckConfig` and then use the service to
|
3004
|
-
# register an instance that creates an alias record, Route
|
3025
|
+
# register an instance that creates an alias record, Route 53
|
3005
3026
|
# doesn't create the health check.
|
3006
3027
|
#
|
3007
3028
|
# **Charges for health checks**
|
3008
3029
|
#
|
3009
|
-
# Health checks are basic Route
|
3030
|
+
# Health checks are basic Route 53 health checks that monitor an AWS
|
3010
3031
|
# endpoint. For information about pricing for health checks, see
|
3011
|
-
# [Amazon Route
|
3032
|
+
# [Amazon Route 53 Pricing][1].
|
3012
3033
|
#
|
3013
3034
|
#
|
3014
3035
|
#
|
@@ -3113,9 +3134,9 @@ module Aws::ServiceDiscovery
|
|
3113
3134
|
# @return [String]
|
3114
3135
|
#
|
3115
3136
|
# @!attribute [rw] value
|
3116
|
-
# The string value
|
3117
|
-
#
|
3118
|
-
#
|
3137
|
+
# The string value associated with the key of the tag. You can set the
|
3138
|
+
# value of a tag to an empty string, but you can't set the value of a
|
3139
|
+
# tag to null.
|
3119
3140
|
# @return [String]
|
3120
3141
|
#
|
3121
3142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Tag AWS API Documentation
|
@@ -3164,7 +3185,7 @@ module Aws::ServiceDiscovery
|
|
3164
3185
|
#
|
3165
3186
|
class TagResourceResponse < Aws::EmptyStructure; end
|
3166
3187
|
|
3167
|
-
# The list of tags on the resource is over the
|
3188
|
+
# The list of tags on the resource is over the quota. The maximum number
|
3168
3189
|
# of tags that can be applied to a resource is 50.
|
3169
3190
|
#
|
3170
3191
|
# @!attribute [rw] message
|