aws-sdk-servicediscovery 1.35.0 → 1.36.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6f73c3cba52718cd49187f0e517a50725823f9a5e93a4dc64ec8da5dc7bb1e7c
4
- data.tar.gz: 72a140daf32ced7dc254a7a10bd1ba72c1096d53b5783e5bf2318d28d0fda0dd
3
+ metadata.gz: f779bdf7fcaf639385391736aa8af29c6ac99ef23eedade55647e0fe592b9e69
4
+ data.tar.gz: e46cc499f772ed190b673334289258337fce2f6e02e39e036080f460dae16b17
5
5
  SHA512:
6
- metadata.gz: d153878e57f5dd403d3f053b910c12ab6e213cda290a6b9753fa1600678d49152046a1b4cf9344b171dfcaa7d23ec61efc63fca36dc8584b895c8289d9dc84f4
7
- data.tar.gz: 9d1c0375baaf29b0d084060f2080f59962ac05389f74e315fced821a95816e573f86ab8e0441b91f1e18391336b0b182b3fe24475a1ea9df40086bfe0e689dfa
6
+ metadata.gz: a0b64780a123acf6674bb6e93e45674ac8fdf39e0685c903c561beecc1b7e26ab0bdbf40cb6e1aa65d48f2d0da6142a33758c91e7eea1ff8e53db2f8a57f948a
7
+ data.tar.gz: 4cb521c7fbee4777cad38c1eac870fa0b2497f084e9f1416a073d3226c1615c3c5e977a45956d6a7668bd3761be70e11d0f8d9d89bbab3de76aa92456e38845f
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.36.0 (2021-06-01)
5
+ ------------------
6
+
7
+ * Feature - Bugfixes - The DiscoverInstances API operation now provides an option to return all instances for health-checked services when there are no healthy instances available.
8
+
4
9
  1.35.0 (2021-05-06)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.35.0
1
+ 1.36.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-servicediscovery/customizations'
48
48
  # @!group service
49
49
  module Aws::ServiceDiscovery
50
50
 
51
- GEM_VERSION = '1.35.0'
51
+ GEM_VERSION = '1.36.0'
52
52
 
53
53
  end
@@ -337,9 +337,9 @@ module Aws::ServiceDiscovery
337
337
 
338
338
  # @!group API Operations
339
339
 
340
- # Creates an HTTP namespace. Service instances that you register using
341
- # an HTTP namespace can be discovered using a `DiscoverInstances`
342
- # request but can't be discovered using DNS.
340
+ # Creates an HTTP namespace. Service instances registered using an HTTP
341
+ # namespace can be discovered using a `DiscoverInstances` request but
342
+ # can't be discovered using DNS.
343
343
  #
344
344
  # For the current quota on the number of namespaces that you can create
345
345
  # using the same AWS account, see [AWS Cloud Map quotas][1] in the *AWS
@@ -356,7 +356,7 @@ module Aws::ServiceDiscovery
356
356
  # A unique string that identifies the request and that allows failed
357
357
  # `CreateHttpNamespace` requests to be retried without the risk of
358
358
  # running the operation twice. `CreatorRequestId` can be any unique
359
- # string, for example, a date/time stamp.
359
+ # string (for example, a date/time stamp).
360
360
  #
361
361
  # **A suitable default value is auto-generated.** You should normally
362
362
  # not need to pass this option.**
@@ -420,9 +420,11 @@ module Aws::ServiceDiscovery
420
420
  # a specified Amazon VPC. The namespace defines your service naming
421
421
  # scheme. For example, if you name your namespace `example.com` and name
422
422
  # your service `backend`, the resulting DNS name for the service is
423
- # `backend.example.com`. For the current quota on the number of
424
- # namespaces that you can create using the same AWS account, see [AWS
425
- # Cloud Map Limits][1] in the *AWS Cloud Map Developer Guide*.
423
+ # `backend.example.com`. Service instances that are registered using a
424
+ # private DNS namespace can be discovered using either a
425
+ # `DiscoverInstances` request or using DNS. For the current quota on the
426
+ # number of namespaces that you can create using the same AWS account,
427
+ # see [AWS Cloud Map Limits][1] in the *AWS Cloud Map Developer Guide*.
426
428
  #
427
429
  #
428
430
  #
@@ -437,7 +439,7 @@ module Aws::ServiceDiscovery
437
439
  # A unique string that identifies the request and that allows failed
438
440
  # `CreatePrivateDnsNamespace` requests to be retried without the risk of
439
441
  # running the operation twice. `CreatorRequestId` can be any unique
440
- # string, for example, a date/timestamp.
442
+ # string (for example, a date/timestamp).
441
443
  #
442
444
  # **A suitable default value is auto-generated.** You should normally
443
445
  # not need to pass this option.**
@@ -506,9 +508,11 @@ module Aws::ServiceDiscovery
506
508
  # internet. The namespace defines your service naming scheme. For
507
509
  # example, if you name your namespace `example.com` and name your
508
510
  # service `backend`, the resulting DNS name for the service is
509
- # `backend.example.com`. For the current quota on the number of
511
+ # `backend.example.com`. You can discover instances that were registered
512
+ # with a public DNS namespace by using either a `DiscoverInstances`
513
+ # request or using DNS. For the current quota on the number of
510
514
  # namespaces that you can create using the same AWS account, see [AWS
511
- # Cloud Map Limits][1] in the *AWS Cloud Map Developer Guide*.
515
+ # Cloud Map Quotas][1]in the *AWS Cloud Map Developer Guide*.
512
516
  #
513
517
  #
514
518
  #
@@ -521,7 +525,7 @@ module Aws::ServiceDiscovery
521
525
  # A unique string that identifies the request and that allows failed
522
526
  # `CreatePublicDnsNamespace` requests to be retried without the risk of
523
527
  # running the operation twice. `CreatorRequestId` can be any unique
524
- # string, for example, a date/timestamp.
528
+ # string (for example, a date/timestamp).
525
529
  #
526
530
  # **A suitable default value is auto-generated.** You should normally
527
531
  # not need to pass this option.**
@@ -581,8 +585,8 @@ module Aws::ServiceDiscovery
581
585
  req.send_request(options)
582
586
  end
583
587
 
584
- # Creates a service, which defines the configuration for the following
585
- # entities:
588
+ # Creates a service. This action defines the configuration for the
589
+ # following entities:
586
590
  #
587
591
  # * For public and private DNS namespaces, one of the following
588
592
  # combinations of DNS records in Amazon Route 53:
@@ -625,9 +629,9 @@ module Aws::ServiceDiscovery
625
629
  #
626
630
  # When you register an instance, AWS Cloud Map creates an `SRV` record
627
631
  # and assigns a name to the record by concatenating the service name and
628
- # the namespace name, for example:
632
+ # the namespace name (for example,
629
633
  #
630
- # `_exampleservice._tcp.example.com`
634
+ # `_exampleservice._tcp.example.com`).
631
635
  #
632
636
  # <note markdown="1"> For services that are accessible by DNS queries, you can't create
633
637
  # multiple services with names that differ only by case (such as EXAMPLE
@@ -650,8 +654,8 @@ module Aws::ServiceDiscovery
650
654
  # @option params [String] :creator_request_id
651
655
  # A unique string that identifies the request and that allows failed
652
656
  # `CreateService` requests to be retried without the risk of running the
653
- # operation twice. `CreatorRequestId` can be any unique string, for
654
- # example, a date/timestamp.
657
+ # operation twice. `CreatorRequestId` can be any unique string (for
658
+ # example, a date/timestamp).
655
659
  #
656
660
  # **A suitable default value is auto-generated.** You should normally
657
661
  # not need to pass this option.**
@@ -697,7 +701,7 @@ module Aws::ServiceDiscovery
697
701
  #
698
702
  # @option params [String] :type
699
703
  # If present, specifies that the service instances are only discoverable
700
- # using the `DiscoverInstances` API operation. No DNS records will be
704
+ # using the `DiscoverInstances` API operation. No DNS records is
701
705
  # registered for the service instances. The only valid value is `HTTP`.
702
706
  #
703
707
  # @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -949,8 +953,8 @@ module Aws::ServiceDiscovery
949
953
  # queries to discover instances.
950
954
  #
951
955
  # @option params [required, String] :namespace_name
952
- # The `HttpName` name of the namespace, found in the `HttpProperties`
953
- # member of the `Properties` member of the namespace.
956
+ # The `HttpName` name of the namespace. It's found in the
957
+ # `HttpProperties` member of the `Properties` member of the namespace.
954
958
  #
955
959
  # @option params [required, String] :service_name
956
960
  # The name of the service that you specified when you registered the
@@ -964,18 +968,39 @@ module Aws::ServiceDiscovery
964
968
  #
965
969
  # @option params [Hash<String,String>] :query_parameters
966
970
  # Filters to scope the results based on custom attributes for the
967
- # instance. For example, `\{version=v1, az=1a\}`. Only instances that
971
+ # instance (for example, `\{version=v1, az=1a\}`). Only instances that
968
972
  # match all the specified key-value pairs are returned.
969
973
  #
970
974
  # @option params [Hash<String,String>] :optional_parameters
971
975
  # Opportunistic filters to scope the results based on custom attributes.
972
976
  # If there are instances that match both the filters specified in both
973
- # the `QueryParameters` parameter and this parameter, they are returned.
974
- # Otherwise, these filters are ignored and only instances that match the
975
- # filters specified in the `QueryParameters` parameter are returned.
977
+ # the `QueryParameters` parameter and this parameter, all of these
978
+ # instances are returned. Otherwise, the filters are ignored, and only
979
+ # instances that match the filters that are specified in the
980
+ # `QueryParameters` parameter are returned.
976
981
  #
977
982
  # @option params [String] :health_status
978
- # The health status of the instances that you want to discover.
983
+ # The health status of the instances that you want to discover. This
984
+ # parameter is ignored for services that don't have a health check
985
+ # configured, and all instances are returned.
986
+ #
987
+ # HEALTHY
988
+ #
989
+ # : Returns healthy instances.
990
+ #
991
+ # UNHEALTHY
992
+ #
993
+ # : Returns unhealthy instances.
994
+ #
995
+ # ALL
996
+ #
997
+ # : Returns all instances.
998
+ #
999
+ # HEALTHY\_OR\_ELSE\_ALL
1000
+ #
1001
+ # : Returns healthy instances, unless none are reporting a healthy
1002
+ # state. In that case, return all instances. This is also called
1003
+ # failing open.
979
1004
  #
980
1005
  # @return [Types::DiscoverInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
981
1006
  #
@@ -1021,7 +1046,7 @@ module Aws::ServiceDiscovery
1021
1046
  # optional_parameters: {
1022
1047
  # "AttrKey" => "AttrValue",
1023
1048
  # },
1024
- # health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
1049
+ # health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL, HEALTHY_OR_ELSE_ALL
1025
1050
  # })
1026
1051
  #
1027
1052
  # @example Response structure
@@ -1105,7 +1130,7 @@ module Aws::ServiceDiscovery
1105
1130
  # Gets the current health status (`Healthy`, `Unhealthy`, or `Unknown`)
1106
1131
  # of one or more instances that are associated with a specified service.
1107
1132
  #
1108
- # <note markdown="1"> There is a brief delay between when you register an instance and when
1133
+ # <note markdown="1"> There's a brief delay between when you register an instance and when
1109
1134
  # the health status for the instance is available.
1110
1135
  #
1111
1136
  # </note>
@@ -1875,9 +1900,9 @@ module Aws::ServiceDiscovery
1875
1900
  # health check based on the settings in a specified service. When you
1876
1901
  # submit a `RegisterInstance` request, the following occurs:
1877
1902
  #
1878
- # * For each DNS record that you define in the service that is specified
1903
+ # * For each DNS record that you define in the service that's specified
1879
1904
  # by `ServiceId`, a record is created or updated in the hosted zone
1880
- # that is associated with the corresponding namespace.
1905
+ # that's associated with the corresponding namespace.
1881
1906
  #
1882
1907
  # * If the service includes `HealthCheckConfig`, a health check is
1883
1908
  # created based on the settings in the health check configuration.
@@ -1918,14 +1943,14 @@ module Aws::ServiceDiscovery
1918
1943
  # An identifier that you want to associate with the instance. Note the
1919
1944
  # following:
1920
1945
  #
1921
- # * If the service that is specified by `ServiceId` includes settings
1946
+ # * If the service that's specified by `ServiceId` includes settings
1922
1947
  # for an `SRV` record, the value of `InstanceId` is automatically
1923
1948
  # included as part of the value for the `SRV` record. For more
1924
1949
  # information, see [DnsRecord &gt; Type][1].
1925
1950
  #
1926
1951
  # * You can use this value to update an existing instance.
1927
1952
  #
1928
- # * To register a new instance, you must specify a value that is unique
1953
+ # * To register a new instance, you must specify a value that's unique
1929
1954
  # among instances that you register by using the same service.
1930
1955
  #
1931
1956
  # * If you specify an existing `InstanceId` and `ServiceId`, AWS Cloud
@@ -1948,8 +1973,8 @@ module Aws::ServiceDiscovery
1948
1973
  # executing the operation twice. You must use a unique
1949
1974
  # `CreatorRequestId` string every time you submit a `RegisterInstance`
1950
1975
  # request if you're registering additional instances for the same
1951
- # namespace and service. `CreatorRequestId` can be any unique string,
1952
- # for example, a date/time stamp.
1976
+ # namespace and service. `CreatorRequestId` can be any unique string
1977
+ # (for example, a date/time stamp).
1953
1978
  #
1954
1979
  # **A suitable default value is auto-generated.** You should normally
1955
1980
  # not need to pass this option.**
@@ -1969,20 +1994,20 @@ module Aws::ServiceDiscovery
1969
1994
  #
1970
1995
  # : If you want AWS Cloud Map to create an Amazon Route 53 alias record
1971
1996
  # that routes traffic to an Elastic Load Balancing load balancer,
1972
- # specify the DNS name that is associated with the load balancer. For
1997
+ # specify the DNS name that's associated with the load balancer. For
1973
1998
  # information about how to get the DNS name, see "DNSName" in the
1974
1999
  # topic [AliasTarget][1] in the *Route 53 API Reference*.
1975
2000
  #
1976
2001
  # Note the following:
1977
2002
  #
1978
- # * The configuration for the service that is specified by `ServiceId`
2003
+ # * The configuration for the service that's specified by `ServiceId`
1979
2004
  # must include settings for an `A` record, an `AAAA` record, or
1980
2005
  # both.
1981
2006
  #
1982
- # * In the service that is specified by `ServiceId`, the value of
2007
+ # * In the service that's specified by `ServiceId`, the value of
1983
2008
  # `RoutingPolicy` must be `WEIGHTED`.
1984
2009
  #
1985
- # * If the service that is specified by `ServiceId` includes
2010
+ # * If the service that's specified by `ServiceId` includes
1986
2011
  # `HealthCheckConfig` settings, AWS Cloud Map will create the
1987
2012
  # Route 53 health check, but it doesn't associate the health check
1988
2013
  # with the alias record.
@@ -2014,8 +2039,8 @@ module Aws::ServiceDiscovery
2014
2039
  # AWS\_INSTANCE\_CNAME
2015
2040
  #
2016
2041
  # : If the service configuration includes a `CNAME` record, the domain
2017
- # name that you want Route 53 to return in response to DNS queries,
2018
- # for example, `example.com`.
2042
+ # name that you want Route 53 to return in response to DNS queries
2043
+ # (for example, `example.com`).
2019
2044
  #
2020
2045
  # This value is required if the service specified by `ServiceId`
2021
2046
  # includes settings for an `CNAME` record.
@@ -2023,8 +2048,8 @@ module Aws::ServiceDiscovery
2023
2048
  # AWS\_INSTANCE\_IPV4
2024
2049
  #
2025
2050
  # : If the service configuration includes an `A` record, the IPv4
2026
- # address that you want Route 53 to return in response to DNS queries,
2027
- # for example, `192.0.2.44`.
2051
+ # address that you want Route 53 to return in response to DNS queries
2052
+ # (for example, `192.0.2.44`).
2028
2053
  #
2029
2054
  # This value is required if the service specified by `ServiceId`
2030
2055
  # includes settings for an `A` record. If the service includes
@@ -2034,8 +2059,8 @@ module Aws::ServiceDiscovery
2034
2059
  # AWS\_INSTANCE\_IPV6
2035
2060
  #
2036
2061
  # : If the service configuration includes an `AAAA` record, the IPv6
2037
- # address that you want Route 53 to return in response to DNS queries,
2038
- # for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
2062
+ # address that you want Route 53 to return in response to DNS queries
2063
+ # (for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`).
2039
2064
  #
2040
2065
  # This value is required if the service specified by `ServiceId`
2041
2066
  # includes settings for an `AAAA` record. If the service includes
@@ -2382,7 +2407,7 @@ module Aws::ServiceDiscovery
2382
2407
  params: params,
2383
2408
  config: config)
2384
2409
  context[:gem_name] = 'aws-sdk-servicediscovery'
2385
- context[:gem_version] = '1.35.0'
2410
+ context[:gem_version] = '1.36.0'
2386
2411
  Seahorse::Client::Request.new(handlers, context)
2387
2412
  end
2388
2413
 
@@ -33,7 +33,7 @@ module Aws::ServiceDiscovery
33
33
  # A unique string that identifies the request and that allows failed
34
34
  # `CreateHttpNamespace` requests to be retried without the risk of
35
35
  # running the operation twice. `CreatorRequestId` can be any unique
36
- # string, for example, a date/time stamp.
36
+ # string (for example, a date/time stamp).
37
37
  #
38
38
  # **A suitable default value is auto-generated.** You should normally
39
39
  # not need to pass this option.
@@ -106,7 +106,7 @@ module Aws::ServiceDiscovery
106
106
  # A unique string that identifies the request and that allows failed
107
107
  # `CreatePrivateDnsNamespace` requests to be retried without the risk
108
108
  # of running the operation twice. `CreatorRequestId` can be any unique
109
- # string, for example, a date/timestamp.
109
+ # string (for example, a date/timestamp).
110
110
  #
111
111
  # **A suitable default value is auto-generated.** You should normally
112
112
  # not need to pass this option.
@@ -181,7 +181,7 @@ module Aws::ServiceDiscovery
181
181
  # A unique string that identifies the request and that allows failed
182
182
  # `CreatePublicDnsNamespace` requests to be retried without the risk
183
183
  # of running the operation twice. `CreatorRequestId` can be any unique
184
- # string, for example, a date/timestamp.
184
+ # string (for example, a date/timestamp).
185
185
  #
186
186
  # **A suitable default value is auto-generated.** You should normally
187
187
  # not need to pass this option.
@@ -276,9 +276,9 @@ module Aws::ServiceDiscovery
276
276
  #
277
277
  # When you register an instance, AWS Cloud Map creates an `SRV` record
278
278
  # and assigns a name to the record by concatenating the service name
279
- # and the namespace name, for example:
279
+ # and the namespace name (for example,
280
280
  #
281
- # `_exampleservice._tcp.example.com`
281
+ # `_exampleservice._tcp.example.com`).
282
282
  #
283
283
  # <note markdown="1"> For services that are accessible by DNS queries, you can't create
284
284
  # multiple services with names that differ only by case (such as
@@ -303,8 +303,8 @@ module Aws::ServiceDiscovery
303
303
  # @!attribute [rw] creator_request_id
304
304
  # A unique string that identifies the request and that allows failed
305
305
  # `CreateService` requests to be retried without the risk of running
306
- # the operation twice. `CreatorRequestId` can be any unique string,
307
- # for example, a date/timestamp.
306
+ # the operation twice. `CreatorRequestId` can be any unique string
307
+ # (for example, a date/timestamp).
308
308
  #
309
309
  # **A suitable default value is auto-generated.** You should normally
310
310
  # not need to pass this option.
@@ -359,7 +359,7 @@ module Aws::ServiceDiscovery
359
359
  # @!attribute [rw] type
360
360
  # If present, specifies that the service instances are only
361
361
  # discoverable using the `DiscoverInstances` API operation. No DNS
362
- # records will be registered for the service instances. The only valid
362
+ # records is registered for the service instances. The only valid
363
363
  # value is `HTTP`.
364
364
  # @return [String]
365
365
  #
@@ -525,12 +525,12 @@ module Aws::ServiceDiscovery
525
525
  # optional_parameters: {
526
526
  # "AttrKey" => "AttrValue",
527
527
  # },
528
- # health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL
528
+ # health_status: "HEALTHY", # accepts HEALTHY, UNHEALTHY, ALL, HEALTHY_OR_ELSE_ALL
529
529
  # }
530
530
  #
531
531
  # @!attribute [rw] namespace_name
532
- # The `HttpName` name of the namespace, found in the `HttpProperties`
533
- # member of the `Properties` member of the namespace.
532
+ # The `HttpName` name of the namespace. It's found in the
533
+ # `HttpProperties` member of the `Properties` member of the namespace.
534
534
  # @return [String]
535
535
  #
536
536
  # @!attribute [rw] service_name
@@ -547,7 +547,7 @@ module Aws::ServiceDiscovery
547
547
  #
548
548
  # @!attribute [rw] query_parameters
549
549
  # Filters to scope the results based on custom attributes for the
550
- # instance. For example, `\{version=v1, az=1a\}`. Only instances that
550
+ # instance (for example, `\{version=v1, az=1a\}`). Only instances that
551
551
  # match all the specified key-value pairs are returned.
552
552
  # @return [Hash<String,String>]
553
553
  #
@@ -555,13 +555,33 @@ module Aws::ServiceDiscovery
555
555
  # Opportunistic filters to scope the results based on custom
556
556
  # attributes. If there are instances that match both the filters
557
557
  # specified in both the `QueryParameters` parameter and this
558
- # parameter, they are returned. Otherwise, these filters are ignored
559
- # and only instances that match the filters specified in the
560
- # `QueryParameters` parameter are returned.
558
+ # parameter, all of these instances are returned. Otherwise, the
559
+ # filters are ignored, and only instances that match the filters that
560
+ # are specified in the `QueryParameters` parameter are returned.
561
561
  # @return [Hash<String,String>]
562
562
  #
563
563
  # @!attribute [rw] health_status
564
- # The health status of the instances that you want to discover.
564
+ # The health status of the instances that you want to discover. This
565
+ # parameter is ignored for services that don't have a health check
566
+ # configured, and all instances are returned.
567
+ #
568
+ # HEALTHY
569
+ #
570
+ # : Returns healthy instances.
571
+ #
572
+ # UNHEALTHY
573
+ #
574
+ # : Returns unhealthy instances.
575
+ #
576
+ # ALL
577
+ #
578
+ # : Returns all instances.
579
+ #
580
+ # HEALTHY\_OR\_ELSE\_ALL
581
+ #
582
+ # : Returns healthy instances, unless none are reporting a healthy
583
+ # state. In that case, return all instances. This is also called
584
+ # failing open.
565
585
  # @return [String]
566
586
  #
567
587
  # @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DiscoverInstancesRequest AWS API Documentation
@@ -878,7 +898,7 @@ module Aws::ServiceDiscovery
878
898
  # @return [String]
879
899
  #
880
900
  # @!attribute [rw] duplicate_operation_id
881
- # The ID of the operation that is already in progress.
901
+ # The ID of the operation that's already in progress.
882
902
  # @return [String]
883
903
  #
884
904
  # @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DuplicateRequest AWS API Documentation
@@ -1119,9 +1139,9 @@ module Aws::ServiceDiscovery
1119
1139
  #
1120
1140
  # : If `DnsConfig` includes configurations for both `A` and `AAAA`
1121
1141
  # records, AWS Cloud Map creates a health check that uses the IPv4
1122
- # address to check the health of the resource. If the endpoint that is
1123
- # specified by the IPv4 address is unhealthy, Route 53 considers both
1124
- # the `A` and `AAAA` records to be unhealthy.
1142
+ # address to check the health of the resource. If the endpoint
1143
+ # tthat's specified by the IPv4 address is unhealthy, Route 53
1144
+ # considers both the `A` and `AAAA` records to be unhealthy.
1125
1145
  #
1126
1146
  # CNAME records
1127
1147
  #
@@ -1131,17 +1151,18 @@ module Aws::ServiceDiscovery
1131
1151
  #
1132
1152
  # Request interval
1133
1153
  #
1134
- # : A Route 53 health checker in each health-checking region sends a
1154
+ # : A Route 53 health checker in each health-checking AWS Region sends a
1135
1155
  # health check request to an endpoint every 30 seconds. On average,
1136
1156
  # your endpoint receives a health check request about every two
1137
1157
  # seconds. However, health checkers don't coordinate with one
1138
- # another, so you'll sometimes see several requests per second
1139
- # followed by a few seconds with no health checks at all.
1158
+ # another. Therefore, you might sometimes see several requests in one
1159
+ # second that's followed by a few seconds with no health checks at
1160
+ # all.
1140
1161
  #
1141
1162
  # Health checking regions
1142
1163
  #
1143
1164
  # : Health checkers perform checks from all Route 53 health-checking
1144
- # regions. For a list of the current regions, see [Regions][2].
1165
+ # Regions. For a list of the current Regions, see [Regions][2].
1145
1166
  #
1146
1167
  # Alias records
1147
1168
  #
@@ -1215,11 +1236,11 @@ module Aws::ServiceDiscovery
1215
1236
  #
1216
1237
  # @!attribute [rw] resource_path
1217
1238
  # The path that you want Route 53 to request when performing health
1218
- # checks. The path can be any value for which your endpoint returns an
1219
- # HTTP status code of a 2xx or 3xx format when the endpoint is
1220
- # healthy, such as the file `/docs/route53-health-check.html`.
1221
- # Route 53 automatically adds the DNS name for the service. If you
1222
- # don't specify a value for `ResourcePath`, the default value is `/`.
1239
+ # checks. The path can be any value that your endpoint returns an HTTP
1240
+ # status code of a 2xx or 3xx format for when the endpoint is healthy.
1241
+ # An example file is `/docs/route53-health-check.html`. Route 53
1242
+ # automatically adds the DNS name for the service. If you don't
1243
+ # specify a value for `ResourcePath`, the default value is `/`.
1223
1244
  #
1224
1245
  # If you specify `TCP` for `Type`, you must *not* specify a value for
1225
1246
  # `ResourcePath`.
@@ -1252,14 +1273,14 @@ module Aws::ServiceDiscovery
1252
1273
  # third-party health checker to evaluate the health of your resources,
1253
1274
  # is useful in the following circumstances:
1254
1275
  #
1255
- # * You can't use a health check that is defined by `HealthCheckConfig`
1276
+ # * You can't use a health check that's defined by `HealthCheckConfig`
1256
1277
  # because the resource isn't available over the internet. For
1257
1278
  # example, you can use a custom health check when the instance is in
1258
1279
  # an Amazon VPC. (To check the health of resources in a VPC, the
1259
1280
  # health checker must also be in the VPC.)
1260
1281
  #
1261
1282
  # * You want to use a third-party health checker regardless of where
1262
- # your resources are.
1283
+ # your resources are located.
1263
1284
  #
1264
1285
  # If you specify a health check configuration, you can specify either
1265
1286
  # `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
@@ -1272,18 +1293,12 @@ module Aws::ServiceDiscovery
1272
1293
  #
1273
1294
  # Here's how custom health checks work:
1274
1295
  #
1275
- # 1. You create a service and specify a value for `FailureThreshold`.
1276
- #
1277
- # The failure threshold indicates the number of 30-second intervals
1278
- # you want AWS Cloud Map to wait between the time that your
1279
- # application sends an [UpdateInstanceCustomHealthStatus][1] request
1280
- # and the time that AWS Cloud Map stops routing internet traffic to
1281
- # the corresponding resource.
1296
+ # 1. You create a service.
1282
1297
  #
1283
1298
  # 2. You register an instance.
1284
1299
  #
1285
1300
  # 3. You configure a third-party health checker to monitor the resource
1286
- # that is associated with the new instance.
1301
+ # that's associated with the new instance.
1287
1302
  #
1288
1303
  # <note markdown="1"> AWS Cloud Map doesn't check the health of the resource directly.
1289
1304
  #
@@ -1295,16 +1310,12 @@ module Aws::ServiceDiscovery
1295
1310
  # 5. Your application submits an `UpdateInstanceCustomHealthStatus`
1296
1311
  # request.
1297
1312
  #
1298
- # 6. AWS Cloud Map waits for (`FailureThreshold` x 30) seconds.
1313
+ # 6. AWS Cloud Map waits for 30 seconds.
1299
1314
  #
1300
1315
  # 7. If another `UpdateInstanceCustomHealthStatus` request doesn't
1301
1316
  # arrive during that time to change the status back to healthy, AWS
1302
1317
  # Cloud Map stops routing traffic to the resource.
1303
1318
  #
1304
- #
1305
- #
1306
- # [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html
1307
- #
1308
1319
  # @note When making an API call, you may pass HealthCheckCustomConfig
1309
1320
  # data as a hash:
1310
1321
  #
@@ -1313,8 +1324,8 @@ module Aws::ServiceDiscovery
1313
1324
  # }
1314
1325
  #
1315
1326
  # @!attribute [rw] failure_threshold
1316
- # This parameter has been deprecated and is always set to 1. AWS Cloud
1317
- # Map waits for approximately 30 seconds after receiving an
1327
+ # This parameter is no longer supported and is always set to 1. AWS
1328
+ # Cloud Map waits for approximately 30 seconds after receiving an
1318
1329
  # `UpdateInstanceCustomHealthStatus` request before changing the
1319
1330
  # status of the service instance.
1320
1331
  #
@@ -1350,7 +1361,7 @@ module Aws::ServiceDiscovery
1350
1361
  # @return [String]
1351
1362
  #
1352
1363
  # @!attribute [rw] namespace_name
1353
- # ` </p> The HttpName name of the namespace, found in the
1364
+ # ` </p> The HttpName name of the namespace. It's found in the
1354
1365
  # HttpProperties member of the Properties member of the namespace.
1355
1366
  # `
1356
1367
  # @return [String]
@@ -1403,14 +1414,14 @@ module Aws::ServiceDiscovery
1403
1414
  # An identifier that you want to associate with the instance. Note the
1404
1415
  # following:
1405
1416
  #
1406
- # * If the service that is specified by `ServiceId` includes settings
1417
+ # * If the service that's specified by `ServiceId` includes settings
1407
1418
  # for an `SRV` record, the value of `InstanceId` is automatically
1408
1419
  # included as part of the value for the `SRV` record. For more
1409
1420
  # information, see [DnsRecord &gt; Type][1].
1410
1421
  #
1411
1422
  # * You can use this value to update an existing instance.
1412
1423
  #
1413
- # * To register a new instance, you must specify a value that is
1424
+ # * To register a new instance, you must specify a value that's
1414
1425
  # unique among instances that you register by using the same
1415
1426
  # service.
1416
1427
  #
@@ -1436,8 +1447,8 @@ module Aws::ServiceDiscovery
1436
1447
  # executing the operation twice. You must use a unique
1437
1448
  # `CreatorRequestId` string every time you submit a `RegisterInstance`
1438
1449
  # request if you're registering additional instances for the same
1439
- # namespace and service. `CreatorRequestId` can be any unique string,
1440
- # for example, a date/time stamp.
1450
+ # namespace and service. `CreatorRequestId` can be any unique string
1451
+ # (for example, a date/time stamp).
1441
1452
  # @return [String]
1442
1453
  #
1443
1454
  # @!attribute [rw] attributes
@@ -1455,20 +1466,20 @@ module Aws::ServiceDiscovery
1455
1466
  #
1456
1467
  # : If you want AWS Cloud Map to create a Route 53 alias record that
1457
1468
  # routes traffic to an Elastic Load Balancing load balancer, specify
1458
- # the DNS name that is associated with the load balancer. For
1469
+ # the DNS name that's associated with the load balancer. For
1459
1470
  # information about how to get the DNS name, see
1460
1471
  # [AliasTarget-&gt;DNSName][1] in the *Route 53 API Reference*.
1461
1472
  #
1462
1473
  # Note the following:
1463
1474
  #
1464
- # * The configuration for the service that is specified by
1475
+ # * The configuration for the service that's specified by
1465
1476
  # `ServiceId` must include settings for an `A` record, an `AAAA`
1466
1477
  # record, or both.
1467
1478
  #
1468
- # * In the service that is specified by `ServiceId`, the value of
1479
+ # * In the service that's specified by `ServiceId`, the value of
1469
1480
  # `RoutingPolicy` must be `WEIGHTED`.
1470
1481
  #
1471
- # * If the service that is specified by `ServiceId` includes
1482
+ # * If the service that's specified by `ServiceId` includes
1472
1483
  # `HealthCheckConfig` settings, AWS Cloud Map creates the health
1473
1484
  # check, but it won't associate the health check with the alias
1474
1485
  # record.
@@ -1497,8 +1508,8 @@ module Aws::ServiceDiscovery
1497
1508
  # AWS\_INSTANCE\_CNAME
1498
1509
  #
1499
1510
  # : If the service configuration includes a `CNAME` record, the domain
1500
- # name that you want Route 53 to return in response to DNS queries,
1501
- # for example, `example.com`.
1511
+ # name that you want Route 53 to return in response to DNS queries
1512
+ # (for example, `example.com`).
1502
1513
  #
1503
1514
  # This value is required if the service specified by `ServiceId`
1504
1515
  # includes settings for an `CNAME` record.
@@ -1507,7 +1518,7 @@ module Aws::ServiceDiscovery
1507
1518
  #
1508
1519
  # : If the service configuration includes an `A` record, the IPv4
1509
1520
  # address that you want Route 53 to return in response to DNS
1510
- # queries, for example, `192.0.2.44`.
1521
+ # queries (for example, `192.0.2.44`).
1511
1522
  #
1512
1523
  # This value is required if the service specified by `ServiceId`
1513
1524
  # includes settings for an `A` record. If the service includes
@@ -1518,7 +1529,7 @@ module Aws::ServiceDiscovery
1518
1529
  #
1519
1530
  # : If the service configuration includes an `AAAA` record, the IPv6
1520
1531
  # address that you want Route 53 to return in response to DNS
1521
- # queries, for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
1532
+ # queries (for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`).
1522
1533
  #
1523
1534
  # This value is required if the service specified by `ServiceId`
1524
1535
  # includes settings for an `AAAA` record. If the service includes
@@ -1576,7 +1587,7 @@ module Aws::ServiceDiscovery
1576
1587
  # @!attribute [rw] attributes
1577
1588
  # A string map that contains the following information:
1578
1589
  #
1579
- # * The attributes that are associate with the instance.
1590
+ # * The attributes that are associated with the instance.
1580
1591
  #
1581
1592
  # * For each attribute, the applicable value.
1582
1593
  #
@@ -1585,7 +1596,7 @@ module Aws::ServiceDiscovery
1585
1596
  # AWS\_ALIAS\_DNS\_NAME
1586
1597
  #
1587
1598
  # : For an alias record that routes traffic to an Elastic Load
1588
- # Balancing load balancer, the DNS name that is associated with the
1599
+ # Balancing load balancer, the DNS name that's associated with the
1589
1600
  # load balancer.
1590
1601
  #
1591
1602
  # AWS\_EC2\_INSTANCE\_ID (HTTP namespaces only)
@@ -1606,18 +1617,18 @@ module Aws::ServiceDiscovery
1606
1617
  # AWS\_INSTANCE\_CNAME
1607
1618
  #
1608
1619
  # : For a `CNAME` record, the domain name that Route 53 returns in
1609
- # response to DNS queries, for example, `example.com`.
1620
+ # response to DNS queries (for example, `example.com`).
1610
1621
  #
1611
1622
  # AWS\_INSTANCE\_IPV4
1612
1623
  #
1613
1624
  # : For an `A` record, the IPv4 address that Route 53 returns in
1614
- # response to DNS queries, for example, `192.0.2.44`.
1625
+ # response to DNS queries (for example, `192.0.2.44`).
1615
1626
  #
1616
1627
  # AWS\_INSTANCE\_IPV6
1617
1628
  #
1618
1629
  # : For an `AAAA` record, the IPv6 address that Route 53 returns in
1619
- # response to DNS queries, for example,
1620
- # `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
1630
+ # response to DNS queries (for example,
1631
+ # `2001:0db8:85a3:0000:0000:abcd:0001:2345`).
1621
1632
  #
1622
1633
  # AWS\_INSTANCE\_PORT
1623
1634
  #
@@ -2166,7 +2177,7 @@ module Aws::ServiceDiscovery
2166
2177
  include Aws::Structure
2167
2178
  end
2168
2179
 
2169
- # A complex type that contains information that is specific to the
2180
+ # A complex type that contains information that's specific to the
2170
2181
  # namespace type.
2171
2182
  #
2172
2183
  # @!attribute [rw] dns_properties
@@ -2246,7 +2257,7 @@ module Aws::ServiceDiscovery
2246
2257
  # @return [String]
2247
2258
  #
2248
2259
  # @!attribute [rw] type
2249
- # The name of the operation that is associated with the specified ID.
2260
+ # The name of the operation that's associated with the specified ID.
2250
2261
  # @return [String]
2251
2262
  #
2252
2263
  # @!attribute [rw] status
@@ -2254,7 +2265,8 @@ module Aws::ServiceDiscovery
2254
2265
  #
2255
2266
  # SUBMITTED
2256
2267
  #
2257
- # : This is the initial state immediately after you submit a request.
2268
+ # : This is the initial state that occurs immediately after you submit
2269
+ # a request.
2258
2270
  #
2259
2271
  # PENDING
2260
2272
  #
@@ -2310,7 +2322,7 @@ module Aws::ServiceDiscovery
2310
2322
  # @return [Time]
2311
2323
  #
2312
2324
  # @!attribute [rw] targets
2313
- # The name of the target entity that is associated with the operation:
2325
+ # The name of the target entity that's associated with the operation:
2314
2326
  #
2315
2327
  # NAMESPACE
2316
2328
  #
@@ -2487,14 +2499,14 @@ module Aws::ServiceDiscovery
2487
2499
  # An identifier that you want to associate with the instance. Note the
2488
2500
  # following:
2489
2501
  #
2490
- # * If the service that is specified by `ServiceId` includes settings
2502
+ # * If the service that's specified by `ServiceId` includes settings
2491
2503
  # for an `SRV` record, the value of `InstanceId` is automatically
2492
2504
  # included as part of the value for the `SRV` record. For more
2493
2505
  # information, see [DnsRecord &gt; Type][1].
2494
2506
  #
2495
2507
  # * You can use this value to update an existing instance.
2496
2508
  #
2497
- # * To register a new instance, you must specify a value that is
2509
+ # * To register a new instance, you must specify a value that's
2498
2510
  # unique among instances that you register by using the same
2499
2511
  # service.
2500
2512
  #
@@ -2520,8 +2532,8 @@ module Aws::ServiceDiscovery
2520
2532
  # executing the operation twice. You must use a unique
2521
2533
  # `CreatorRequestId` string every time you submit a `RegisterInstance`
2522
2534
  # request if you're registering additional instances for the same
2523
- # namespace and service. `CreatorRequestId` can be any unique string,
2524
- # for example, a date/time stamp.
2535
+ # namespace and service. `CreatorRequestId` can be any unique string
2536
+ # (for example, a date/time stamp).
2525
2537
  #
2526
2538
  # **A suitable default value is auto-generated.** You should normally
2527
2539
  # not need to pass this option.
@@ -2542,21 +2554,21 @@ module Aws::ServiceDiscovery
2542
2554
  #
2543
2555
  # : If you want AWS Cloud Map to create an Amazon Route 53 alias
2544
2556
  # record that routes traffic to an Elastic Load Balancing load
2545
- # balancer, specify the DNS name that is associated with the load
2557
+ # balancer, specify the DNS name that's associated with the load
2546
2558
  # balancer. For information about how to get the DNS name, see
2547
2559
  # "DNSName" in the topic [AliasTarget][1] in the *Route 53 API
2548
2560
  # Reference*.
2549
2561
  #
2550
2562
  # Note the following:
2551
2563
  #
2552
- # * The configuration for the service that is specified by
2564
+ # * The configuration for the service that's specified by
2553
2565
  # `ServiceId` must include settings for an `A` record, an `AAAA`
2554
2566
  # record, or both.
2555
2567
  #
2556
- # * In the service that is specified by `ServiceId`, the value of
2568
+ # * In the service that's specified by `ServiceId`, the value of
2557
2569
  # `RoutingPolicy` must be `WEIGHTED`.
2558
2570
  #
2559
- # * If the service that is specified by `ServiceId` includes
2571
+ # * If the service that's specified by `ServiceId` includes
2560
2572
  # `HealthCheckConfig` settings, AWS Cloud Map will create the
2561
2573
  # Route 53 health check, but it doesn't associate the health
2562
2574
  # check with the alias record.
@@ -2588,8 +2600,8 @@ module Aws::ServiceDiscovery
2588
2600
  # AWS\_INSTANCE\_CNAME
2589
2601
  #
2590
2602
  # : If the service configuration includes a `CNAME` record, the domain
2591
- # name that you want Route 53 to return in response to DNS queries,
2592
- # for example, `example.com`.
2603
+ # name that you want Route 53 to return in response to DNS queries
2604
+ # (for example, `example.com`).
2593
2605
  #
2594
2606
  # This value is required if the service specified by `ServiceId`
2595
2607
  # includes settings for an `CNAME` record.
@@ -2598,7 +2610,7 @@ module Aws::ServiceDiscovery
2598
2610
  #
2599
2611
  # : If the service configuration includes an `A` record, the IPv4
2600
2612
  # address that you want Route 53 to return in response to DNS
2601
- # queries, for example, `192.0.2.44`.
2613
+ # queries (for example, `192.0.2.44`).
2602
2614
  #
2603
2615
  # This value is required if the service specified by `ServiceId`
2604
2616
  # includes settings for an `A` record. If the service includes
@@ -2609,7 +2621,7 @@ module Aws::ServiceDiscovery
2609
2621
  #
2610
2622
  # : If the service configuration includes an `AAAA` record, the IPv6
2611
2623
  # address that you want Route 53 to return in response to DNS
2612
- # queries, for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
2624
+ # queries (for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`).
2613
2625
  #
2614
2626
  # This value is required if the service specified by `ServiceId`
2615
2627
  # includes settings for an `AAAA` record. If the service includes
@@ -2758,8 +2770,8 @@ module Aws::ServiceDiscovery
2758
2770
  # @!attribute [rw] instance_count
2759
2771
  # The number of instances that are currently associated with the
2760
2772
  # service. Instances that were previously associated with the service
2761
- # but that have been deleted are not included in the count. The count
2762
- # might not reflect pending registrations and deregistrations.
2773
+ # but that are deleted aren't included in the count. The count might
2774
+ # not reflect pending registrations and deregistrations.
2763
2775
  # @return [Integer]
2764
2776
  #
2765
2777
  # @!attribute [rw] dns_config
@@ -2819,8 +2831,8 @@ module Aws::ServiceDiscovery
2819
2831
  # @!attribute [rw] creator_request_id
2820
2832
  # A unique string that identifies the request and that allows failed
2821
2833
  # requests to be retried without the risk of running the operation
2822
- # twice. `CreatorRequestId` can be any unique string, for example, a
2823
- # date/timestamp.
2834
+ # twice. `CreatorRequestId` can be any unique string (for example, a
2835
+ # date/timestamp).
2824
2836
  # @return [String]
2825
2837
  #
2826
2838
  # @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Service AWS API Documentation
@@ -3015,8 +3027,8 @@ module Aws::ServiceDiscovery
3015
3027
  # @!attribute [rw] instance_count
3016
3028
  # The number of instances that are currently associated with the
3017
3029
  # service. Instances that were previously associated with the service
3018
- # but that have been deleted are not included in the count. The count
3019
- # might not reflect pending registrations and deregistrations.
3030
+ # but that are deleted aren't included in the count. The count might
3031
+ # not reflect pending registrations and deregistrations.
3020
3032
  # @return [Integer]
3021
3033
  #
3022
3034
  # @!attribute [rw] dns_config
@@ -3037,14 +3049,14 @@ module Aws::ServiceDiscovery
3037
3049
  # evaluate the health of your resources, is useful in the following
3038
3050
  # circumstances:
3039
3051
  #
3040
- # * You can't use a health check that is defined by
3052
+ # * You can't use a health check that's defined by
3041
3053
  # `HealthCheckConfig` because the resource isn't available over the
3042
3054
  # internet. For example, you can use a custom health check when the
3043
3055
  # instance is in an Amazon VPC. (To check the health of resources in
3044
3056
  # a VPC, the health checker must also be in the VPC.)
3045
3057
  #
3046
3058
  # * You want to use a third-party health checker regardless of where
3047
- # your resources are.
3059
+ # your resources are located.
3048
3060
  #
3049
3061
  # If you specify a health check configuration, you can specify either
3050
3062
  # `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
@@ -3071,7 +3083,7 @@ module Aws::ServiceDiscovery
3071
3083
  include Aws::Structure
3072
3084
  end
3073
3085
 
3074
- # A custom key-value pair associated with a resource.
3086
+ # A custom key-value pair that's associated with a resource.
3075
3087
  #
3076
3088
  # @note When making an API call, you may pass Tag
3077
3089
  # data as a hash:
@@ -3086,9 +3098,9 @@ module Aws::ServiceDiscovery
3086
3098
  # @return [String]
3087
3099
  #
3088
3100
  # @!attribute [rw] value
3089
- # The string value associated with the key of the tag. You can set the
3090
- # value of a tag to an empty string, but you can't set the value of a
3091
- # tag to null.
3101
+ # The string value that's associated with the key of the tag. You can
3102
+ # set the value of a tag to an empty string, but you can't set the
3103
+ # value of a tag to null.
3092
3104
  # @return [String]
3093
3105
  #
3094
3106
  # @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Tag AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-servicediscovery
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.35.0
4
+ version: 1.36.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-05-06 00:00:00.000000000 Z
11
+ date: 2021-06-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core