aws-sdk-servicediscovery 1.34.0 → 1.35.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-servicediscovery.rb +1 -1
- data/lib/aws-sdk-servicediscovery/client.rb +112 -112
- data/lib/aws-sdk-servicediscovery/client_api.rb +2 -1
- data/lib/aws-sdk-servicediscovery/types.rb +420 -525
- metadata +5 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6f73c3cba52718cd49187f0e517a50725823f9a5e93a4dc64ec8da5dc7bb1e7c
|
4
|
+
data.tar.gz: 72a140daf32ced7dc254a7a10bd1ba72c1096d53b5783e5bf2318d28d0fda0dd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d153878e57f5dd403d3f053b910c12ab6e213cda290a6b9753fa1600678d49152046a1b4cf9344b171dfcaa7d23ec61efc63fca36dc8584b895c8289d9dc84f4
|
7
|
+
data.tar.gz: 9d1c0375baaf29b0d084060f2080f59962ac05389f74e315fced821a95816e573f86ab8e0441b91f1e18391336b0b182b3fe24475a1ea9df40086bfe0e689dfa
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.35.0
|
@@ -355,7 +355,7 @@ module Aws::ServiceDiscovery
|
|
355
355
|
# @option params [String] :creator_request_id
|
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
359
|
# string, for example, a date/time stamp.
|
360
360
|
#
|
361
361
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -366,9 +366,8 @@ module Aws::ServiceDiscovery
|
|
366
366
|
#
|
367
367
|
# @option params [Array<Types::Tag>] :tags
|
368
368
|
# The tags to add to the namespace. Each tag consists of a key and an
|
369
|
-
# optional value
|
370
|
-
#
|
371
|
-
# length of 256 characters.
|
369
|
+
# optional value that you define. Tags keys can be up to 128 characters
|
370
|
+
# in length, and tag values can be up to 256 characters in length.
|
372
371
|
#
|
373
372
|
# @return [Types::CreateHttpNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
374
373
|
#
|
@@ -417,13 +416,13 @@ module Aws::ServiceDiscovery
|
|
417
416
|
req.send_request(options)
|
418
417
|
end
|
419
418
|
|
420
|
-
# Creates a private namespace based on DNS, which
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
419
|
+
# Creates a private namespace based on DNS, which is visible only inside
|
420
|
+
# a specified Amazon VPC. The namespace defines your service naming
|
421
|
+
# scheme. For example, if you name your namespace `example.com` and name
|
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*.
|
427
426
|
#
|
428
427
|
#
|
429
428
|
#
|
@@ -437,8 +436,8 @@ module Aws::ServiceDiscovery
|
|
437
436
|
# @option params [String] :creator_request_id
|
438
437
|
# A unique string that identifies the request and that allows failed
|
439
438
|
# `CreatePrivateDnsNamespace` requests to be retried without the risk of
|
440
|
-
#
|
441
|
-
# string, for example, a date/
|
439
|
+
# running the operation twice. `CreatorRequestId` can be any unique
|
440
|
+
# string, for example, a date/timestamp.
|
442
441
|
#
|
443
442
|
# **A suitable default value is auto-generated.** You should normally
|
444
443
|
# not need to pass this option.**
|
@@ -452,9 +451,8 @@ module Aws::ServiceDiscovery
|
|
452
451
|
#
|
453
452
|
# @option params [Array<Types::Tag>] :tags
|
454
453
|
# The tags to add to the namespace. Each tag consists of a key and an
|
455
|
-
# optional value
|
456
|
-
#
|
457
|
-
# length of 256 characters.
|
454
|
+
# optional value that you define. Tags keys can be up to 128 characters
|
455
|
+
# in length, and tag values can be up to 256 characters in length.
|
458
456
|
#
|
459
457
|
# @return [Types::CreatePrivateDnsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
460
458
|
#
|
@@ -504,10 +502,10 @@ module Aws::ServiceDiscovery
|
|
504
502
|
req.send_request(options)
|
505
503
|
end
|
506
504
|
|
507
|
-
# Creates a public namespace based on DNS, which
|
505
|
+
# Creates a public namespace based on DNS, which is visible on the
|
508
506
|
# internet. The namespace defines your service naming scheme. For
|
509
507
|
# example, if you name your namespace `example.com` and name your
|
510
|
-
# service `backend`, the resulting DNS name for the service
|
508
|
+
# service `backend`, the resulting DNS name for the service is
|
511
509
|
# `backend.example.com`. For the current quota on the number of
|
512
510
|
# namespaces that you can create using the same AWS account, see [AWS
|
513
511
|
# Cloud Map Limits][1] in the *AWS Cloud Map Developer Guide*.
|
@@ -522,8 +520,8 @@ module Aws::ServiceDiscovery
|
|
522
520
|
# @option params [String] :creator_request_id
|
523
521
|
# A unique string that identifies the request and that allows failed
|
524
522
|
# `CreatePublicDnsNamespace` requests to be retried without the risk of
|
525
|
-
#
|
526
|
-
# string, for example, a date/
|
523
|
+
# running the operation twice. `CreatorRequestId` can be any unique
|
524
|
+
# string, for example, a date/timestamp.
|
527
525
|
#
|
528
526
|
# **A suitable default value is auto-generated.** You should normally
|
529
527
|
# not need to pass this option.**
|
@@ -533,9 +531,8 @@ module Aws::ServiceDiscovery
|
|
533
531
|
#
|
534
532
|
# @option params [Array<Types::Tag>] :tags
|
535
533
|
# The tags to add to the namespace. Each tag consists of a key and an
|
536
|
-
# optional value
|
537
|
-
#
|
538
|
-
# length of 256 characters.
|
534
|
+
# optional value that you define. Tags keys can be up to 128 characters
|
535
|
+
# in length, and tag values can be up to 256 characters in length.
|
539
536
|
#
|
540
537
|
# @return [Types::CreatePublicDnsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
541
538
|
#
|
@@ -619,12 +616,12 @@ module Aws::ServiceDiscovery
|
|
619
616
|
# The name that you want to assign to the service.
|
620
617
|
#
|
621
618
|
# If you want AWS Cloud Map to create an `SRV` record when you register
|
622
|
-
# an instance
|
623
|
-
#
|
619
|
+
# an instance and you're using a system that requires a specific `SRV`
|
620
|
+
# format, such as [HAProxy][1], specify the following for `Name`\:
|
624
621
|
#
|
625
|
-
# * Start the name with an underscore (\_), such as `_exampleservice
|
622
|
+
# * Start the name with an underscore (\_), such as `_exampleservice`.
|
626
623
|
#
|
627
|
-
# * End the name with *.\_protocol*, such as `._tcp
|
624
|
+
# * End the name with *.\_protocol*, such as `._tcp`.
|
628
625
|
#
|
629
626
|
# When you register an instance, AWS Cloud Map creates an `SRV` record
|
630
627
|
# and assigns a name to the record by concatenating the service name and
|
@@ -632,11 +629,12 @@ module Aws::ServiceDiscovery
|
|
632
629
|
#
|
633
630
|
# `_exampleservice._tcp.example.com`
|
634
631
|
#
|
635
|
-
# <note markdown="1"> For
|
636
|
-
# that differ only by case (such as EXAMPLE
|
637
|
-
# these services
|
638
|
-
#
|
639
|
-
#
|
632
|
+
# <note markdown="1"> For services that are accessible by DNS queries, you can't create
|
633
|
+
# multiple services with names that differ only by case (such as EXAMPLE
|
634
|
+
# and example). Otherwise, these services have the same DNS name and
|
635
|
+
# can't be distinguished. However, if you use a namespace that's only
|
636
|
+
# accessible by API calls, then you can create services that with names
|
637
|
+
# that differ only by case.
|
640
638
|
#
|
641
639
|
# </note>
|
642
640
|
#
|
@@ -646,12 +644,14 @@ module Aws::ServiceDiscovery
|
|
646
644
|
#
|
647
645
|
# @option params [String] :namespace_id
|
648
646
|
# The ID of the namespace that you want to use to create the service.
|
647
|
+
# The namespace ID must be specified, but it can be specified either
|
648
|
+
# here or in the `DnsConfig` object.
|
649
649
|
#
|
650
650
|
# @option params [String] :creator_request_id
|
651
651
|
# A unique string that identifies the request and that allows failed
|
652
|
-
# `CreateService` requests to be retried without the risk of
|
653
|
-
#
|
654
|
-
# example, a date/
|
652
|
+
# `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.
|
655
655
|
#
|
656
656
|
# **A suitable default value is auto-generated.** You should normally
|
657
657
|
# not need to pass this option.**
|
@@ -692,9 +692,8 @@ module Aws::ServiceDiscovery
|
|
692
692
|
#
|
693
693
|
# @option params [Array<Types::Tag>] :tags
|
694
694
|
# The tags to add to the service. Each tag consists of a key and an
|
695
|
-
# optional value
|
696
|
-
#
|
697
|
-
# length of 256 characters.
|
695
|
+
# optional value that you define. Tags keys can be up to 128 characters
|
696
|
+
# in length, and tag values can be up to 256 characters in length.
|
698
697
|
#
|
699
698
|
# @option params [String] :type
|
700
699
|
# If present, specifies that the service instances are only discoverable
|
@@ -950,8 +949,8 @@ module Aws::ServiceDiscovery
|
|
950
949
|
# queries to discover instances.
|
951
950
|
#
|
952
951
|
# @option params [required, String] :namespace_name
|
953
|
-
# The name of the namespace
|
954
|
-
#
|
952
|
+
# The `HttpName` name of the namespace, found in the `HttpProperties`
|
953
|
+
# member of the `Properties` member of the namespace.
|
955
954
|
#
|
956
955
|
# @option params [required, String] :service_name
|
957
956
|
# The name of the service that you specified when you registered the
|
@@ -966,7 +965,7 @@ module Aws::ServiceDiscovery
|
|
966
965
|
# @option params [Hash<String,String>] :query_parameters
|
967
966
|
# Filters to scope the results based on custom attributes for the
|
968
967
|
# instance. For example, `\{version=v1, az=1a\}`. Only instances that
|
969
|
-
# match all the specified key-value pairs
|
968
|
+
# match all the specified key-value pairs are returned.
|
970
969
|
#
|
971
970
|
# @option params [Hash<String,String>] :optional_parameters
|
972
971
|
# Opportunistic filters to scope the results based on custom attributes.
|
@@ -1966,100 +1965,101 @@ module Aws::ServiceDiscovery
|
|
1966
1965
|
#
|
1967
1966
|
# Supported attribute keys include the following:
|
1968
1967
|
#
|
1969
|
-
#
|
1968
|
+
# AWS\_ALIAS\_DNS\_NAME
|
1970
1969
|
#
|
1971
|
-
# If you want AWS Cloud Map to create an Amazon Route 53 alias record
|
1972
|
-
#
|
1973
|
-
#
|
1974
|
-
#
|
1975
|
-
#
|
1970
|
+
# : If you want AWS Cloud Map to create an Amazon Route 53 alias record
|
1971
|
+
# that routes traffic to an Elastic Load Balancing load balancer,
|
1972
|
+
# specify the DNS name that is associated with the load balancer. For
|
1973
|
+
# information about how to get the DNS name, see "DNSName" in the
|
1974
|
+
# topic [AliasTarget][1] in the *Route 53 API Reference*.
|
1976
1975
|
#
|
1977
|
-
#
|
1976
|
+
# Note the following:
|
1978
1977
|
#
|
1979
|
-
#
|
1980
|
-
#
|
1978
|
+
# * The configuration for the service that is specified by `ServiceId`
|
1979
|
+
# must include settings for an `A` record, an `AAAA` record, or
|
1980
|
+
# both.
|
1981
1981
|
#
|
1982
|
-
#
|
1983
|
-
#
|
1982
|
+
# * In the service that is specified by `ServiceId`, the value of
|
1983
|
+
# `RoutingPolicy` must be `WEIGHTED`.
|
1984
1984
|
#
|
1985
|
-
#
|
1986
|
-
#
|
1987
|
-
#
|
1988
|
-
#
|
1985
|
+
# * If the service that is specified by `ServiceId` includes
|
1986
|
+
# `HealthCheckConfig` settings, AWS Cloud Map will create the
|
1987
|
+
# Route 53 health check, but it doesn't associate the health check
|
1988
|
+
# with the alias record.
|
1989
1989
|
#
|
1990
|
-
#
|
1991
|
-
#
|
1992
|
-
#
|
1990
|
+
# * Auto naming currently doesn't support creating alias records that
|
1991
|
+
# route traffic to AWS resources other than Elastic Load Balancing
|
1992
|
+
# load balancers.
|
1993
1993
|
#
|
1994
|
-
#
|
1995
|
-
#
|
1994
|
+
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
1995
|
+
# values for any of the `AWS_INSTANCE` attributes.
|
1996
1996
|
#
|
1997
|
-
#
|
1997
|
+
# AWS\_EC2\_INSTANCE\_ID
|
1998
1998
|
#
|
1999
|
-
# *HTTP namespaces only.* The Amazon EC2 instance ID for the instance.
|
2000
|
-
#
|
2001
|
-
#
|
2002
|
-
#
|
2003
|
-
#
|
2004
|
-
#
|
1999
|
+
# : *HTTP namespaces only.* The Amazon EC2 instance ID for the instance.
|
2000
|
+
# If the `AWS_EC2_INSTANCE_ID` attribute is specified, then the only
|
2001
|
+
# other attribute that can be specified is `AWS_INIT_HEALTH_STATUS`.
|
2002
|
+
# When the `AWS_EC2_INSTANCE_ID` attribute is specified, then the
|
2003
|
+
# `AWS_INSTANCE_IPV4` attribute will be filled out with the primary
|
2004
|
+
# private IPv4 address.
|
2005
2005
|
#
|
2006
|
-
#
|
2006
|
+
# AWS\_INIT\_HEALTH\_STATUS
|
2007
2007
|
#
|
2008
|
-
# If the service configuration includes `HealthCheckCustomConfig`, you
|
2009
|
-
#
|
2010
|
-
#
|
2011
|
-
#
|
2012
|
-
#
|
2008
|
+
# : If the service configuration includes `HealthCheckCustomConfig`, you
|
2009
|
+
# can optionally use `AWS_INIT_HEALTH_STATUS` to specify the initial
|
2010
|
+
# status of the custom health check, `HEALTHY` or `UNHEALTHY`. If you
|
2011
|
+
# don't specify a value for `AWS_INIT_HEALTH_STATUS`, the initial
|
2012
|
+
# status is `HEALTHY`.
|
2013
2013
|
#
|
2014
|
-
#
|
2014
|
+
# AWS\_INSTANCE\_CNAME
|
2015
2015
|
#
|
2016
|
-
# If the service configuration includes a `CNAME` record, the domain
|
2017
|
-
#
|
2018
|
-
#
|
2016
|
+
# : 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`.
|
2019
2019
|
#
|
2020
|
-
#
|
2021
|
-
#
|
2020
|
+
# This value is required if the service specified by `ServiceId`
|
2021
|
+
# includes settings for an `CNAME` record.
|
2022
2022
|
#
|
2023
|
-
#
|
2023
|
+
# AWS\_INSTANCE\_IPV4
|
2024
2024
|
#
|
2025
|
-
# If the service configuration includes an `A` record, the IPv4
|
2026
|
-
#
|
2027
|
-
#
|
2025
|
+
# : 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`.
|
2028
2028
|
#
|
2029
|
-
#
|
2030
|
-
#
|
2031
|
-
#
|
2032
|
-
#
|
2029
|
+
# This value is required if the service specified by `ServiceId`
|
2030
|
+
# includes settings for an `A` record. If the service includes
|
2031
|
+
# settings for an `SRV` record, you must specify a value for
|
2032
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
2033
2033
|
#
|
2034
|
-
#
|
2034
|
+
# AWS\_INSTANCE\_IPV6
|
2035
2035
|
#
|
2036
|
-
# If the service configuration includes an `AAAA` record, the IPv6
|
2037
|
-
#
|
2038
|
-
#
|
2036
|
+
# : 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`.
|
2039
2039
|
#
|
2040
|
-
#
|
2041
|
-
#
|
2042
|
-
#
|
2043
|
-
#
|
2040
|
+
# This value is required if the service specified by `ServiceId`
|
2041
|
+
# includes settings for an `AAAA` record. If the service includes
|
2042
|
+
# settings for an `SRV` record, you must specify a value for
|
2043
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
2044
2044
|
#
|
2045
|
-
#
|
2045
|
+
# AWS\_INSTANCE\_PORT
|
2046
2046
|
#
|
2047
|
-
# If the service includes an `SRV` record, the value that you want
|
2048
|
-
#
|
2047
|
+
# : If the service includes an `SRV` record, the value that you want
|
2048
|
+
# Route 53 to return for the port.
|
2049
2049
|
#
|
2050
|
-
#
|
2051
|
-
#
|
2050
|
+
# If the service includes `HealthCheckConfig`, the port on the
|
2051
|
+
# endpoint that you want Route 53 to send requests to.
|
2052
2052
|
#
|
2053
|
-
#
|
2054
|
-
#
|
2053
|
+
# This value is required if you specified settings for an `SRV` record
|
2054
|
+
# or a Route 53 health check when you created the service.
|
2055
2055
|
#
|
2056
|
-
#
|
2056
|
+
# Custom attributes
|
2057
2057
|
#
|
2058
|
-
# You can add up to 30 custom attributes. For each key-value pair, the
|
2059
|
-
#
|
2060
|
-
#
|
2061
|
-
#
|
2062
|
-
#
|
2058
|
+
# : You can add up to 30 custom attributes. For each key-value pair, the
|
2059
|
+
# maximum length of the attribute name is 255 characters, and the
|
2060
|
+
# maximum length of the attribute value is 1,024 characters. The total
|
2061
|
+
# size of all provided attributes (sum of all keys and values) must
|
2062
|
+
# not exceed 5,000 characters.
|
2063
2063
|
#
|
2064
2064
|
#
|
2065
2065
|
#
|
@@ -2093,7 +2093,7 @@ module Aws::ServiceDiscovery
|
|
2093
2093
|
#
|
2094
2094
|
# resp = client.register_instance({
|
2095
2095
|
# service_id: "ResourceId", # required
|
2096
|
-
# instance_id: "
|
2096
|
+
# instance_id: "InstanceId", # required
|
2097
2097
|
# creator_request_id: "ResourceId",
|
2098
2098
|
# attributes: { # required
|
2099
2099
|
# "AttrKey" => "AttrValue",
|
@@ -2288,7 +2288,7 @@ module Aws::ServiceDiscovery
|
|
2288
2288
|
# are deleted from the service.
|
2289
2289
|
#
|
2290
2290
|
# * If you omit an existing `HealthCheckCustomConfig` configuration from
|
2291
|
-
# an `UpdateService` request, the configuration
|
2291
|
+
# an `UpdateService` request, the configuration isn't deleted from
|
2292
2292
|
# the service.
|
2293
2293
|
#
|
2294
2294
|
# When you update settings for a service, AWS Cloud Map also updates the
|
@@ -2382,7 +2382,7 @@ module Aws::ServiceDiscovery
|
|
2382
2382
|
params: params,
|
2383
2383
|
config: config)
|
2384
2384
|
context[:gem_name] = 'aws-sdk-servicediscovery'
|
2385
|
-
context[:gem_version] = '1.
|
2385
|
+
context[:gem_version] = '1.35.0'
|
2386
2386
|
Seahorse::Client::Request.new(handlers, context)
|
2387
2387
|
end
|
2388
2388
|
|
@@ -69,6 +69,7 @@ module Aws::ServiceDiscovery
|
|
69
69
|
HttpProperties = Shapes::StructureShape.new(name: 'HttpProperties')
|
70
70
|
Instance = Shapes::StructureShape.new(name: 'Instance')
|
71
71
|
InstanceHealthStatusMap = Shapes::MapShape.new(name: 'InstanceHealthStatusMap')
|
72
|
+
InstanceId = Shapes::StringShape.new(name: 'InstanceId')
|
72
73
|
InstanceIdList = Shapes::ListShape.new(name: 'InstanceIdList')
|
73
74
|
InstanceNotFound = Shapes::StructureShape.new(name: 'InstanceNotFound')
|
74
75
|
InstanceSummary = Shapes::StructureShape.new(name: 'InstanceSummary')
|
@@ -444,7 +445,7 @@ module Aws::ServiceDiscovery
|
|
444
445
|
OperationTargetsMap.value = Shapes::ShapeRef.new(shape: ResourceId)
|
445
446
|
|
446
447
|
RegisterInstanceRequest.add_member(:service_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "ServiceId"))
|
447
|
-
RegisterInstanceRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape:
|
448
|
+
RegisterInstanceRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
448
449
|
RegisterInstanceRequest.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "CreatorRequestId", metadata: {"idempotencyToken"=>true}))
|
449
450
|
RegisterInstanceRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, required: true, location_name: "Attributes"))
|
450
451
|
RegisterInstanceRequest.struct_class = Types::RegisterInstanceRequest
|
@@ -32,7 +32,7 @@ module Aws::ServiceDiscovery
|
|
32
32
|
# @!attribute [rw] creator_request_id
|
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
36
|
# string, for example, a date/time stamp.
|
37
37
|
#
|
38
38
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -45,9 +45,9 @@ module Aws::ServiceDiscovery
|
|
45
45
|
#
|
46
46
|
# @!attribute [rw] tags
|
47
47
|
# The tags to add to the namespace. Each tag consists of a key and an
|
48
|
-
# optional value
|
49
|
-
#
|
50
|
-
#
|
48
|
+
# optional value that you define. Tags keys can be up to 128
|
49
|
+
# characters in length, and tag values can be up to 256 characters in
|
50
|
+
# length.
|
51
51
|
# @return [Array<Types::Tag>]
|
52
52
|
#
|
53
53
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateHttpNamespaceRequest AWS API Documentation
|
@@ -105,8 +105,8 @@ module Aws::ServiceDiscovery
|
|
105
105
|
# @!attribute [rw] creator_request_id
|
106
106
|
# A unique string that identifies the request and that allows failed
|
107
107
|
# `CreatePrivateDnsNamespace` requests to be retried without the risk
|
108
|
-
# of
|
109
|
-
#
|
108
|
+
# of running the operation twice. `CreatorRequestId` can be any unique
|
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.
|
@@ -123,9 +123,9 @@ module Aws::ServiceDiscovery
|
|
123
123
|
#
|
124
124
|
# @!attribute [rw] tags
|
125
125
|
# The tags to add to the namespace. Each tag consists of a key and an
|
126
|
-
# optional value
|
127
|
-
#
|
128
|
-
#
|
126
|
+
# optional value that you define. Tags keys can be up to 128
|
127
|
+
# characters in length, and tag values can be up to 256 characters in
|
128
|
+
# length.
|
129
129
|
# @return [Array<Types::Tag>]
|
130
130
|
#
|
131
131
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespaceRequest AWS API Documentation
|
@@ -180,8 +180,8 @@ module Aws::ServiceDiscovery
|
|
180
180
|
# @!attribute [rw] creator_request_id
|
181
181
|
# A unique string that identifies the request and that allows failed
|
182
182
|
# `CreatePublicDnsNamespace` requests to be retried without the risk
|
183
|
-
# of
|
184
|
-
#
|
183
|
+
# of running the operation twice. `CreatorRequestId` can be any unique
|
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.
|
@@ -193,9 +193,9 @@ module Aws::ServiceDiscovery
|
|
193
193
|
#
|
194
194
|
# @!attribute [rw] tags
|
195
195
|
# The tags to add to the namespace. Each tag consists of a key and an
|
196
|
-
# optional value
|
197
|
-
#
|
198
|
-
#
|
196
|
+
# optional value that you define. Tags keys can be up to 128
|
197
|
+
# characters in length, and tag values can be up to 256 characters in
|
198
|
+
# length.
|
199
199
|
# @return [Array<Types::Tag>]
|
200
200
|
#
|
201
201
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespaceRequest AWS API Documentation
|
@@ -266,13 +266,13 @@ module Aws::ServiceDiscovery
|
|
266
266
|
# The name that you want to assign to the service.
|
267
267
|
#
|
268
268
|
# If you want AWS Cloud Map to create an `SRV` record when you
|
269
|
-
# register an instance
|
269
|
+
# register an instance and you're using a system that requires a
|
270
270
|
# specific `SRV` format, such as [HAProxy][1], specify the following
|
271
271
|
# for `Name`\:
|
272
272
|
#
|
273
|
-
# * Start the name with an underscore (\_), such as `_exampleservice
|
273
|
+
# * Start the name with an underscore (\_), such as `_exampleservice`.
|
274
274
|
#
|
275
|
-
# * End the name with *.\_protocol*, such as `._tcp
|
275
|
+
# * End the name with *.\_protocol*, such as `._tcp`.
|
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
|
@@ -280,11 +280,12 @@ module Aws::ServiceDiscovery
|
|
280
280
|
#
|
281
281
|
# `_exampleservice._tcp.example.com`
|
282
282
|
#
|
283
|
-
# <note markdown="1"> For
|
284
|
-
# names that differ only by case (such as
|
285
|
-
# Otherwise, these services
|
286
|
-
#
|
287
|
-
#
|
283
|
+
# <note markdown="1"> For services that are accessible by DNS queries, you can't create
|
284
|
+
# multiple services with names that differ only by case (such as
|
285
|
+
# EXAMPLE and example). Otherwise, these services have the same DNS
|
286
|
+
# name and can't be distinguished. However, if you use a namespace
|
287
|
+
# that's only accessible by API calls, then you can create services
|
288
|
+
# that with names that differ only by case.
|
288
289
|
#
|
289
290
|
# </note>
|
290
291
|
#
|
@@ -295,13 +296,15 @@ module Aws::ServiceDiscovery
|
|
295
296
|
#
|
296
297
|
# @!attribute [rw] namespace_id
|
297
298
|
# The ID of the namespace that you want to use to create the service.
|
299
|
+
# The namespace ID must be specified, but it can be specified either
|
300
|
+
# here or in the `DnsConfig` object.
|
298
301
|
# @return [String]
|
299
302
|
#
|
300
303
|
# @!attribute [rw] creator_request_id
|
301
304
|
# A unique string that identifies the request and that allows failed
|
302
|
-
# `CreateService` requests to be retried without the risk of
|
305
|
+
# `CreateService` requests to be retried without the risk of running
|
303
306
|
# the operation twice. `CreatorRequestId` can be any unique string,
|
304
|
-
# for example, a date/
|
307
|
+
# for example, a date/timestamp.
|
305
308
|
#
|
306
309
|
# **A suitable default value is auto-generated.** You should normally
|
307
310
|
# not need to pass this option.
|
@@ -348,9 +351,9 @@ module Aws::ServiceDiscovery
|
|
348
351
|
#
|
349
352
|
# @!attribute [rw] tags
|
350
353
|
# The tags to add to the service. Each tag consists of a key and an
|
351
|
-
# optional value
|
352
|
-
#
|
353
|
-
#
|
354
|
+
# optional value that you define. Tags keys can be up to 128
|
355
|
+
# characters in length, and tag values can be up to 256 characters in
|
356
|
+
# length.
|
354
357
|
# @return [Array<Types::Tag>]
|
355
358
|
#
|
356
359
|
# @!attribute [rw] type
|
@@ -388,8 +391,8 @@ module Aws::ServiceDiscovery
|
|
388
391
|
include Aws::Structure
|
389
392
|
end
|
390
393
|
|
391
|
-
# The health check for the instance that
|
392
|
-
# `InstanceId`
|
394
|
+
# The health check for the instance that's specified by `ServiceId` and
|
395
|
+
# `InstanceId` isn't a custom health check.
|
393
396
|
#
|
394
397
|
# @!attribute [rw] message
|
395
398
|
# @return [String]
|
@@ -526,8 +529,8 @@ module Aws::ServiceDiscovery
|
|
526
529
|
# }
|
527
530
|
#
|
528
531
|
# @!attribute [rw] namespace_name
|
529
|
-
# The name of the namespace
|
530
|
-
#
|
532
|
+
# The `HttpName` name of the namespace, found in the `HttpProperties`
|
533
|
+
# member of the `Properties` member of the namespace.
|
531
534
|
# @return [String]
|
532
535
|
#
|
533
536
|
# @!attribute [rw] service_name
|
@@ -545,7 +548,7 @@ module Aws::ServiceDiscovery
|
|
545
548
|
# @!attribute [rw] query_parameters
|
546
549
|
# Filters to scope the results based on custom attributes for the
|
547
550
|
# instance. For example, `\{version=v1, az=1a\}`. Only instances that
|
548
|
-
# match all the specified key-value pairs
|
551
|
+
# match all the specified key-value pairs are returned.
|
549
552
|
# @return [Hash<String,String>]
|
550
553
|
#
|
551
554
|
# @!attribute [rw] optional_parameters
|
@@ -621,46 +624,46 @@ module Aws::ServiceDiscovery
|
|
621
624
|
#
|
622
625
|
# You can specify the following values:
|
623
626
|
#
|
624
|
-
#
|
627
|
+
# MULTIVALUE
|
625
628
|
#
|
626
|
-
# If you define a health check for the service and the health check
|
627
|
-
#
|
628
|
-
#
|
629
|
+
# : If you define a health check for the service and the health check
|
630
|
+
# is healthy, Route 53 returns the applicable value for up to eight
|
631
|
+
# instances.
|
629
632
|
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
#
|
633
|
+
# For example, suppose that the service includes configurations for
|
634
|
+
# one `A` record and a health check. You use the service to register
|
635
|
+
# 10 instances. Route 53 responds to DNS queries with IP addresses
|
636
|
+
# for up to eight healthy instances. If fewer than eight instances
|
637
|
+
# are healthy, Route 53 responds to every DNS query with the IP
|
638
|
+
# addresses for all of the healthy instances.
|
636
639
|
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
#
|
640
|
+
# If you don't define a health check for the service, Route 53
|
641
|
+
# assumes that all instances are healthy and returns the values for
|
642
|
+
# up to eight instances.
|
640
643
|
#
|
641
|
-
#
|
642
|
-
#
|
644
|
+
# For more information about the multivalue routing policy, see
|
645
|
+
# [Multivalue Answer Routing][1] in the *Route 53 Developer Guide*.
|
643
646
|
#
|
644
|
-
#
|
647
|
+
# WEIGHTED
|
645
648
|
#
|
646
|
-
# Route 53 returns the applicable value from one randomly selected
|
647
|
-
#
|
648
|
-
#
|
649
|
-
#
|
649
|
+
# : Route 53 returns the applicable value from one randomly selected
|
650
|
+
# instance from among the instances that you registered using the
|
651
|
+
# same service. Currently, all records have the same weight, so you
|
652
|
+
# can't route more or less traffic to any instances.
|
650
653
|
#
|
651
|
-
#
|
652
|
-
#
|
653
|
-
#
|
654
|
-
#
|
655
|
-
#
|
656
|
-
#
|
654
|
+
# For example, suppose that the service includes configurations for
|
655
|
+
# one `A` record and a health check. You use the service to register
|
656
|
+
# 10 instances. Route 53 responds to DNS queries with the IP address
|
657
|
+
# for one randomly selected instance from among the healthy
|
658
|
+
# instances. If no instances are healthy, Route 53 responds to DNS
|
659
|
+
# queries as if all of the instances were healthy.
|
657
660
|
#
|
658
|
-
#
|
659
|
-
#
|
660
|
-
#
|
661
|
+
# If you don't define a health check for the service, Route 53
|
662
|
+
# assumes that all instances are healthy and returns the applicable
|
663
|
+
# value for one randomly selected instance.
|
661
664
|
#
|
662
|
-
#
|
663
|
-
#
|
665
|
+
# For more information about the weighted routing policy, see
|
666
|
+
# [Weighted Routing][2] in the *Route 53 Developer Guide*.
|
664
667
|
#
|
665
668
|
#
|
666
669
|
#
|
@@ -746,15 +749,15 @@ module Aws::ServiceDiscovery
|
|
746
749
|
# Route 53 returns in response to DNS queries. You can specify values
|
747
750
|
# for `Type` in the following combinations:
|
748
751
|
#
|
749
|
-
# *
|
752
|
+
# * <b> <code>A</code> </b>
|
750
753
|
#
|
751
|
-
# *
|
754
|
+
# * <b> <code>AAAA</code> </b>
|
752
755
|
#
|
753
|
-
# *
|
756
|
+
# * <b> <code>A</code> </b> and <b> <code>AAAA</code> </b>
|
754
757
|
#
|
755
|
-
# *
|
758
|
+
# * <b> <code>SRV</code> </b>
|
756
759
|
#
|
757
|
-
# *
|
760
|
+
# * <b> <code>CNAME</code> </b>
|
758
761
|
#
|
759
762
|
# If you want AWS Cloud Map to create a Route 53 alias record when you
|
760
763
|
# register an instance, specify `A` or `AAAA` for `Type`.
|
@@ -765,62 +768,81 @@ module Aws::ServiceDiscovery
|
|
765
768
|
#
|
766
769
|
# The following values are supported:
|
767
770
|
#
|
768
|
-
#
|
769
|
-
#
|
770
|
-
#
|
771
|
-
#
|
772
|
-
#
|
773
|
-
#
|
774
|
-
#
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
779
|
-
#
|
780
|
-
#
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
784
|
-
#
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
790
|
-
#
|
791
|
-
#
|
792
|
-
#
|
793
|
-
#
|
794
|
-
#
|
795
|
-
#
|
796
|
-
#
|
797
|
-
#
|
798
|
-
#
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
803
|
-
#
|
804
|
-
#
|
805
|
-
#
|
806
|
-
#
|
807
|
-
#
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
816
|
-
#
|
817
|
-
#
|
818
|
-
#
|
819
|
-
#
|
771
|
+
# A
|
772
|
+
#
|
773
|
+
# : Route 53 returns the IP address of the resource in IPv4 format,
|
774
|
+
# such as 192.0.2.44.
|
775
|
+
#
|
776
|
+
# AAAA
|
777
|
+
#
|
778
|
+
# : Route 53 returns the IP address of the resource in IPv6 format,
|
779
|
+
# such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
|
780
|
+
#
|
781
|
+
# CNAME
|
782
|
+
#
|
783
|
+
# : Route 53 returns the domain name of the resource, such as
|
784
|
+
# www.example.com. Note the following:
|
785
|
+
#
|
786
|
+
# * You specify the domain name that you want to route traffic to
|
787
|
+
# when you register an instance. For more information, see
|
788
|
+
# [Attributes][2] in the topic [RegisterInstance][1].
|
789
|
+
#
|
790
|
+
# * You must specify `WEIGHTED` for the value of `RoutingPolicy`.
|
791
|
+
#
|
792
|
+
# * You can't specify both `CNAME` for `Type` and settings for
|
793
|
+
# `HealthCheckConfig`. If you do, the request will fail with an
|
794
|
+
# `InvalidInput` error.
|
795
|
+
#
|
796
|
+
# SRV
|
797
|
+
#
|
798
|
+
# : Route 53 returns the value for an `SRV` record. The value for an
|
799
|
+
# `SRV` record uses the following values:
|
800
|
+
#
|
801
|
+
# `priority weight port service-hostname`
|
802
|
+
#
|
803
|
+
# Note the following about the values:
|
804
|
+
#
|
805
|
+
# * The values of `priority` and `weight` are both set to `1` and
|
806
|
+
# can't be changed.
|
807
|
+
#
|
808
|
+
# * The value of `port` comes from the value that you specify for
|
809
|
+
# the `AWS_INSTANCE_PORT` attribute when you submit a
|
810
|
+
# [RegisterInstance][1] request.
|
811
|
+
#
|
812
|
+
# * The value of `service-hostname` is a concatenation of the
|
813
|
+
# following values:
|
814
|
+
#
|
815
|
+
# * The value that you specify for `InstanceId` when you register
|
816
|
+
# an instance.
|
817
|
+
#
|
818
|
+
# * The name of the service.
|
819
|
+
#
|
820
|
+
# * The name of the namespace.
|
821
|
+
#
|
822
|
+
# For example, if the value of `InstanceId` is `test`, the name of
|
823
|
+
# the service is `backend`, and the name of the namespace is
|
824
|
+
# `example.com`, the value of `service-hostname` is the following:
|
825
|
+
#
|
826
|
+
# `test.backend.example.com`
|
827
|
+
#
|
828
|
+
# If you specify settings for an `SRV` record, note the following:
|
829
|
+
#
|
830
|
+
# * If you specify values for `AWS_INSTANCE_IPV4`,
|
831
|
+
# `AWS_INSTANCE_IPV6`, or both in the `RegisterInstance` request,
|
832
|
+
# AWS Cloud Map automatically creates `A` and/or `AAAA` records
|
833
|
+
# that have the same name as the value of `service-hostname` in
|
834
|
+
# the `SRV` record. You can ignore these records.
|
835
|
+
#
|
836
|
+
# * If you're using a system that requires a specific `SRV` format,
|
837
|
+
# such as HAProxy, see the [Name][3] element in the documentation
|
838
|
+
# about `CreateService` for information about how to specify the
|
839
|
+
# correct name format.
|
820
840
|
#
|
821
841
|
#
|
822
842
|
#
|
823
843
|
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html
|
844
|
+
# [2]: https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes
|
845
|
+
# [3]: https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name
|
824
846
|
# @return [String]
|
825
847
|
#
|
826
848
|
# @!attribute [rw] ttl
|
@@ -1093,54 +1115,55 @@ module Aws::ServiceDiscovery
|
|
1093
1115
|
#
|
1094
1116
|
# Note the following about configuring health checks.
|
1095
1117
|
#
|
1096
|
-
#
|
1118
|
+
# A and AAAA records
|
1097
1119
|
#
|
1098
|
-
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
1099
|
-
#
|
1100
|
-
#
|
1101
|
-
#
|
1102
|
-
#
|
1120
|
+
# : If `DnsConfig` includes configurations for both `A` and `AAAA`
|
1121
|
+
# 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.
|
1103
1125
|
#
|
1104
|
-
#
|
1126
|
+
# CNAME records
|
1105
1127
|
#
|
1106
|
-
# You can't specify settings for `HealthCheckConfig` when the
|
1107
|
-
#
|
1108
|
-
#
|
1128
|
+
# : You can't specify settings for `HealthCheckConfig` when the
|
1129
|
+
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
1130
|
+
# `CreateService` request will fail with an `InvalidInput` error.
|
1109
1131
|
#
|
1110
|
-
#
|
1132
|
+
# Request interval
|
1111
1133
|
#
|
1112
|
-
# A Route 53 health checker in each health-checking region sends a
|
1113
|
-
#
|
1114
|
-
# endpoint receives a health check request about every two
|
1115
|
-
# However, health checkers don't coordinate with one
|
1116
|
-
# you'll sometimes see several requests per second
|
1117
|
-
# seconds with no health checks at all.
|
1134
|
+
# : A Route 53 health checker in each health-checking region sends a
|
1135
|
+
# health check request to an endpoint every 30 seconds. On average,
|
1136
|
+
# your endpoint receives a health check request about every two
|
1137
|
+
# 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.
|
1118
1140
|
#
|
1119
|
-
#
|
1141
|
+
# Health checking regions
|
1120
1142
|
#
|
1121
|
-
# Health checkers perform checks from all Route 53 health-checking
|
1122
|
-
#
|
1143
|
+
# : Health checkers perform checks from all Route 53 health-checking
|
1144
|
+
# regions. For a list of the current regions, see [Regions][2].
|
1123
1145
|
#
|
1124
|
-
#
|
1146
|
+
# Alias records
|
1125
1147
|
#
|
1126
|
-
# When you register an instance, if you include the
|
1127
|
-
# attribute, AWS Cloud Map creates a Route 53
|
1128
|
-
# following:
|
1148
|
+
# : When you register an instance, if you include the
|
1149
|
+
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route 53
|
1150
|
+
# alias record. Note the following:
|
1129
1151
|
#
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
#
|
1152
|
+
# * Route 53 automatically sets `EvaluateTargetHealth` to true for
|
1153
|
+
# alias records. When `EvaluateTargetHealth` is true, the alias
|
1154
|
+
# record inherits the health of the referenced AWS resource. such as
|
1155
|
+
# an ELB load balancer. For more information, see
|
1156
|
+
# [EvaluateTargetHealth][3].
|
1134
1157
|
#
|
1135
|
-
#
|
1136
|
-
#
|
1137
|
-
#
|
1158
|
+
# * If you include `HealthCheckConfig` and then use the service to
|
1159
|
+
# register an instance that creates an alias record, Route 53
|
1160
|
+
# doesn't create the health check.
|
1138
1161
|
#
|
1139
|
-
#
|
1162
|
+
# Charges for health checks
|
1140
1163
|
#
|
1141
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
1142
|
-
#
|
1143
|
-
# Route 53 Pricing][1].
|
1164
|
+
# : Health checks are basic Route 53 health checks that monitor an AWS
|
1165
|
+
# endpoint. For information about pricing for health checks, see
|
1166
|
+
# [Amazon Route 53 Pricing][1].
|
1144
1167
|
#
|
1145
1168
|
#
|
1146
1169
|
#
|
@@ -1192,8 +1215,8 @@ module Aws::ServiceDiscovery
|
|
1192
1215
|
#
|
1193
1216
|
# @!attribute [rw] resource_path
|
1194
1217
|
# The path that you want Route 53 to request when performing health
|
1195
|
-
# checks. The path can be any value for which your endpoint
|
1196
|
-
#
|
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
|
1197
1220
|
# healthy, such as the file `/docs/route53-health-check.html`.
|
1198
1221
|
# Route 53 automatically adds the DNS name for the service. If you
|
1199
1222
|
# don't specify a value for `ResourcePath`, the default value is `/`.
|
@@ -1205,9 +1228,9 @@ module Aws::ServiceDiscovery
|
|
1205
1228
|
# @!attribute [rw] failure_threshold
|
1206
1229
|
# The number of consecutive health checks that an endpoint must pass
|
1207
1230
|
# or fail for Route 53 to change the current status of the endpoint
|
1208
|
-
# from unhealthy to healthy or
|
1209
|
-
# [How Route 53 Determines Whether an Endpoint Is
|
1210
|
-
# *Route 53 Developer Guide*.
|
1231
|
+
# from unhealthy to healthy or the other way around. For more
|
1232
|
+
# information, see [How Route 53 Determines Whether an Endpoint Is
|
1233
|
+
# Healthy][1] in the *Route 53 Developer Guide*.
|
1211
1234
|
#
|
1212
1235
|
#
|
1213
1236
|
#
|
@@ -1327,8 +1350,9 @@ module Aws::ServiceDiscovery
|
|
1327
1350
|
# @return [String]
|
1328
1351
|
#
|
1329
1352
|
# @!attribute [rw] namespace_name
|
1330
|
-
# The name of the namespace
|
1331
|
-
#
|
1353
|
+
# ` </p> The HttpName name of the namespace, found in the
|
1354
|
+
# HttpProperties member of the Properties member of the namespace.
|
1355
|
+
# `
|
1332
1356
|
# @return [String]
|
1333
1357
|
#
|
1334
1358
|
# @!attribute [rw] service_name
|
@@ -1427,87 +1451,94 @@ module Aws::ServiceDiscovery
|
|
1427
1451
|
#
|
1428
1452
|
# Supported attribute keys include the following:
|
1429
1453
|
#
|
1430
|
-
#
|
1454
|
+
# AWS\_ALIAS\_DNS\_NAME
|
1431
1455
|
#
|
1432
|
-
#
|
1456
|
+
# : If you want AWS Cloud Map to create a Route 53 alias record that
|
1457
|
+
# routes traffic to an Elastic Load Balancing load balancer, specify
|
1458
|
+
# the DNS name that is associated with the load balancer. For
|
1459
|
+
# information about how to get the DNS name, see
|
1460
|
+
# [AliasTarget->DNSName][1] in the *Route 53 API Reference*.
|
1433
1461
|
#
|
1434
|
-
#
|
1435
|
-
# routes traffic to an Elastic Load Balancing load balancer, specify
|
1436
|
-
# the DNS name that is associated with the load balancer. For
|
1437
|
-
# information about how to get the DNS name, see "DNSName" in the
|
1438
|
-
# topic [AliasTarget][1].
|
1462
|
+
# Note the following:
|
1439
1463
|
#
|
1440
|
-
#
|
1464
|
+
# * The configuration for the service that is specified by
|
1465
|
+
# `ServiceId` must include settings for an `A` record, an `AAAA`
|
1466
|
+
# record, or both.
|
1441
1467
|
#
|
1442
|
-
#
|
1443
|
-
#
|
1444
|
-
# both.
|
1468
|
+
# * In the service that is specified by `ServiceId`, the value of
|
1469
|
+
# `RoutingPolicy` must be `WEIGHTED`.
|
1445
1470
|
#
|
1446
|
-
#
|
1447
|
-
#
|
1471
|
+
# * If the service that is specified by `ServiceId` includes
|
1472
|
+
# `HealthCheckConfig` settings, AWS Cloud Map creates the health
|
1473
|
+
# check, but it won't associate the health check with the alias
|
1474
|
+
# record.
|
1448
1475
|
#
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
#
|
1452
|
-
# record.
|
1476
|
+
# * Auto naming currently doesn't support creating alias records
|
1477
|
+
# that route traffic to AWS resources other than ELB load
|
1478
|
+
# balancers.
|
1453
1479
|
#
|
1454
|
-
#
|
1455
|
-
#
|
1480
|
+
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
1481
|
+
# values for any of the `AWS_INSTANCE` attributes.
|
1456
1482
|
#
|
1457
|
-
#
|
1458
|
-
# values for any of the `AWS_INSTANCE` attributes.
|
1483
|
+
# AWS\_EC2\_INSTANCE\_ID
|
1459
1484
|
#
|
1460
|
-
#
|
1485
|
+
# : *HTTP namespaces only.* The Amazon EC2 instance ID for the
|
1486
|
+
# instance. The `AWS_INSTANCE_IPV4` attribute contains the primary
|
1487
|
+
# private IPv4 address.
|
1461
1488
|
#
|
1462
|
-
#
|
1463
|
-
# The `AWS_INSTANCE_IPV4` attribute contains the primary private IPv4
|
1464
|
-
# address.
|
1489
|
+
# AWS\_INIT\_HEALTH\_STATUS
|
1465
1490
|
#
|
1466
|
-
#
|
1491
|
+
# : If the service configuration includes `HealthCheckCustomConfig`,
|
1492
|
+
# you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the
|
1493
|
+
# initial status of the custom health check, `HEALTHY` or
|
1494
|
+
# `UNHEALTHY`. If you don't specify a value for
|
1495
|
+
# `AWS_INIT_HEALTH_STATUS`, the initial status is `HEALTHY`.
|
1467
1496
|
#
|
1468
|
-
#
|
1469
|
-
# name that you want Route 53 to return in response to DNS queries,
|
1470
|
-
# for example, `example.com`.
|
1497
|
+
# AWS\_INSTANCE\_CNAME
|
1471
1498
|
#
|
1472
|
-
#
|
1473
|
-
#
|
1499
|
+
# : 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`.
|
1474
1502
|
#
|
1475
|
-
#
|
1503
|
+
# This value is required if the service specified by `ServiceId`
|
1504
|
+
# includes settings for an `CNAME` record.
|
1476
1505
|
#
|
1477
|
-
#
|
1478
|
-
# address that you want Route 53 to return in response to DNS queries,
|
1479
|
-
# for example, `192.0.2.44`.
|
1506
|
+
# AWS\_INSTANCE\_IPV4
|
1480
1507
|
#
|
1481
|
-
#
|
1482
|
-
#
|
1483
|
-
#
|
1484
|
-
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1508
|
+
# : If the service configuration includes an `A` record, the IPv4
|
1509
|
+
# address that you want Route 53 to return in response to DNS
|
1510
|
+
# queries, for example, `192.0.2.44`.
|
1485
1511
|
#
|
1486
|
-
#
|
1512
|
+
# This value is required if the service specified by `ServiceId`
|
1513
|
+
# includes settings for an `A` record. If the service includes
|
1514
|
+
# settings for an `SRV` record, you must specify a value for
|
1515
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1487
1516
|
#
|
1488
|
-
#
|
1489
|
-
# address that you want Route 53 to return in response to DNS queries,
|
1490
|
-
# for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
1517
|
+
# AWS\_INSTANCE\_IPV6
|
1491
1518
|
#
|
1492
|
-
#
|
1493
|
-
#
|
1494
|
-
#
|
1495
|
-
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1519
|
+
# : If the service configuration includes an `AAAA` record, the IPv6
|
1520
|
+
# address that you want Route 53 to return in response to DNS
|
1521
|
+
# queries, for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
1496
1522
|
#
|
1497
|
-
#
|
1523
|
+
# This value is required if the service specified by `ServiceId`
|
1524
|
+
# includes settings for an `AAAA` record. If the service includes
|
1525
|
+
# settings for an `SRV` record, you must specify a value for
|
1526
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
1498
1527
|
#
|
1499
|
-
#
|
1500
|
-
# Route 53 to return for the port.
|
1528
|
+
# AWS\_INSTANCE\_PORT
|
1501
1529
|
#
|
1502
|
-
# If the service includes `
|
1503
|
-
#
|
1530
|
+
# : If the service includes an `SRV` record, the value that you want
|
1531
|
+
# Route 53 to return for the port.
|
1504
1532
|
#
|
1505
|
-
#
|
1506
|
-
#
|
1533
|
+
# If the service includes `HealthCheckConfig`, the port on the
|
1534
|
+
# endpoint that you want Route 53 to send requests to.
|
1507
1535
|
#
|
1536
|
+
# This value is required if you specified settings for an `SRV`
|
1537
|
+
# record or a Route 53 health check when you created the service.
|
1508
1538
|
#
|
1509
1539
|
#
|
1510
|
-
#
|
1540
|
+
#
|
1541
|
+
# [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName
|
1511
1542
|
# @return [Hash<String,String>]
|
1512
1543
|
#
|
1513
1544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Instance AWS API Documentation
|
@@ -1551,31 +1582,48 @@ module Aws::ServiceDiscovery
|
|
1551
1582
|
#
|
1552
1583
|
# Supported attribute keys include the following:
|
1553
1584
|
#
|
1554
|
-
#
|
1555
|
-
#
|
1556
|
-
#
|
1585
|
+
# AWS\_ALIAS\_DNS\_NAME
|
1586
|
+
#
|
1587
|
+
# : For an alias record that routes traffic to an Elastic Load
|
1588
|
+
# Balancing load balancer, the DNS name that is associated with the
|
1589
|
+
# load balancer.
|
1590
|
+
#
|
1591
|
+
# AWS\_EC2\_INSTANCE\_ID (HTTP namespaces only)
|
1592
|
+
#
|
1593
|
+
# : The Amazon EC2 instance ID for the instance. When the
|
1594
|
+
# `AWS_EC2_INSTANCE_ID` attribute is specified, then the
|
1595
|
+
# `AWS_INSTANCE_IPV4` attribute contains the primary private IPv4
|
1596
|
+
# address.
|
1597
|
+
#
|
1598
|
+
# AWS\_INIT\_HEALTH\_STATUS
|
1599
|
+
#
|
1600
|
+
# : If the service configuration includes `HealthCheckCustomConfig`,
|
1601
|
+
# you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the
|
1602
|
+
# initial status of the custom health check, `HEALTHY` or
|
1603
|
+
# `UNHEALTHY`. If you don't specify a value for
|
1604
|
+
# `AWS_INIT_HEALTH_STATUS`, the initial status is `HEALTHY`.
|
1557
1605
|
#
|
1558
|
-
#
|
1559
|
-
# instance ID for the instance. When the `AWS_EC2_INSTANCE_ID`
|
1560
|
-
# attribute is specified, then the `AWS_INSTANCE_IPV4` attribute
|
1561
|
-
# contains the primary private IPv4 address.
|
1606
|
+
# AWS\_INSTANCE\_CNAME
|
1562
1607
|
#
|
1563
|
-
#
|
1564
|
-
#
|
1565
|
-
# `example.com`.
|
1608
|
+
# : For a `CNAME` record, the domain name that Route 53 returns in
|
1609
|
+
# response to DNS queries, for example, `example.com`.
|
1566
1610
|
#
|
1567
|
-
#
|
1568
|
-
# Route 53 returns in response to DNS queries, for example,
|
1569
|
-
# `192.0.2.44`.
|
1611
|
+
# AWS\_INSTANCE\_IPV4
|
1570
1612
|
#
|
1571
|
-
#
|
1572
|
-
#
|
1613
|
+
# : For an `A` record, the IPv4 address that Route 53 returns in
|
1614
|
+
# response to DNS queries, for example, `192.0.2.44`.
|
1615
|
+
#
|
1616
|
+
# AWS\_INSTANCE\_IPV6
|
1617
|
+
#
|
1618
|
+
# : For an `AAAA` record, the IPv6 address that Route 53 returns in
|
1619
|
+
# response to DNS queries, for example,
|
1573
1620
|
# `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
1574
1621
|
#
|
1575
|
-
#
|
1576
|
-
#
|
1577
|
-
#
|
1578
|
-
#
|
1622
|
+
# AWS\_INSTANCE\_PORT
|
1623
|
+
#
|
1624
|
+
# : For an `SRV` record, the value that Route 53 returns for the port.
|
1625
|
+
# In addition, if the service includes `HealthCheckConfig`, the port
|
1626
|
+
# on the endpoint that Route 53 sends requests to.
|
1579
1627
|
# @return [Hash<String,String>]
|
1580
1628
|
#
|
1581
1629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/InstanceSummary AWS API Documentation
|
@@ -1968,14 +2016,20 @@ module Aws::ServiceDiscovery
|
|
1968
2016
|
# The type of the namespace. The methods for discovering instances
|
1969
2017
|
# depends on the value that you specify:
|
1970
2018
|
#
|
1971
|
-
#
|
1972
|
-
#
|
2019
|
+
# HTTP
|
2020
|
+
#
|
2021
|
+
# : Instances can be discovered only programmatically, using the AWS
|
2022
|
+
# Cloud Map `DiscoverInstances` API.
|
2023
|
+
#
|
2024
|
+
# DNS\_PUBLIC
|
2025
|
+
#
|
2026
|
+
# : Instances can be discovered using public DNS queries and using the
|
2027
|
+
# `DiscoverInstances` API.
|
1973
2028
|
#
|
1974
|
-
#
|
1975
|
-
# queries and using the `DiscoverInstances` API.
|
2029
|
+
# DNS\_PRIVATE
|
1976
2030
|
#
|
1977
|
-
#
|
1978
|
-
#
|
2031
|
+
# : Instances can be discovered using DNS queries in VPCs and using
|
2032
|
+
# the `DiscoverInstances` API.
|
1979
2033
|
# @return [String]
|
1980
2034
|
#
|
1981
2035
|
# @!attribute [rw] description
|
@@ -2001,7 +2055,7 @@ module Aws::ServiceDiscovery
|
|
2001
2055
|
#
|
2002
2056
|
# @!attribute [rw] creator_request_id
|
2003
2057
|
# A unique string that identifies the request and that allows failed
|
2004
|
-
# requests to be retried without the risk of
|
2058
|
+
# requests to be retried without the risk of running an operation
|
2005
2059
|
# twice.
|
2006
2060
|
# @return [String]
|
2007
2061
|
#
|
@@ -2073,14 +2127,20 @@ module Aws::ServiceDiscovery
|
|
2073
2127
|
# `ListNamespaces` returns a namespace. Valid values for `condition`
|
2074
2128
|
# include:
|
2075
2129
|
#
|
2076
|
-
#
|
2077
|
-
# list only public namespaces or private namespaces, but not both.
|
2078
|
-
# `EQ` is the default condition and can be omitted.
|
2130
|
+
# EQ
|
2079
2131
|
#
|
2080
|
-
#
|
2081
|
-
#
|
2132
|
+
# : When you specify `EQ` for the condition, you can choose to list
|
2133
|
+
# only public namespaces or private namespaces, but not both. `EQ`
|
2134
|
+
# is the default condition and can be omitted.
|
2082
2135
|
#
|
2083
|
-
#
|
2136
|
+
# IN
|
2137
|
+
#
|
2138
|
+
# : When you specify `IN` for the condition, you can choose to list
|
2139
|
+
# public namespaces, private namespaces, or both.
|
2140
|
+
#
|
2141
|
+
# BETWEEN
|
2142
|
+
#
|
2143
|
+
# : Not applicable
|
2084
2144
|
# @return [String]
|
2085
2145
|
#
|
2086
2146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/NamespaceFilter AWS API Documentation
|
@@ -2157,8 +2217,7 @@ module Aws::ServiceDiscovery
|
|
2157
2217
|
# @return [Integer]
|
2158
2218
|
#
|
2159
2219
|
# @!attribute [rw] properties
|
2160
|
-
#
|
2161
|
-
# namespace type.
|
2220
|
+
# The properties of the namespace.
|
2162
2221
|
# @return [Types::NamespaceProperties]
|
2163
2222
|
#
|
2164
2223
|
# @!attribute [rw] create_date
|
@@ -2193,15 +2252,21 @@ module Aws::ServiceDiscovery
|
|
2193
2252
|
# @!attribute [rw] status
|
2194
2253
|
# The status of the operation. Values include the following:
|
2195
2254
|
#
|
2196
|
-
#
|
2197
|
-
# submit a request.
|
2255
|
+
# SUBMITTED
|
2198
2256
|
#
|
2199
|
-
#
|
2257
|
+
# : This is the initial state immediately after you submit a request.
|
2200
2258
|
#
|
2201
|
-
#
|
2259
|
+
# PENDING
|
2202
2260
|
#
|
2203
|
-
#
|
2204
|
-
#
|
2261
|
+
# : AWS Cloud Map is performing the operation.
|
2262
|
+
#
|
2263
|
+
# SUCCESS
|
2264
|
+
#
|
2265
|
+
# : The operation succeeded.
|
2266
|
+
#
|
2267
|
+
# FAIL
|
2268
|
+
#
|
2269
|
+
# : The operation failed. For the failure reason, see `ErrorMessage`.
|
2205
2270
|
# @return [String]
|
2206
2271
|
#
|
2207
2272
|
# @!attribute [rw] error_message
|
@@ -2247,14 +2312,17 @@ module Aws::ServiceDiscovery
|
|
2247
2312
|
# @!attribute [rw] targets
|
2248
2313
|
# The name of the target entity that is associated with the operation:
|
2249
2314
|
#
|
2250
|
-
#
|
2251
|
-
# property.
|
2315
|
+
# NAMESPACE
|
2252
2316
|
#
|
2253
|
-
#
|
2254
|
-
# property.
|
2317
|
+
# : The namespace ID is returned in the `ResourceId` property.
|
2255
2318
|
#
|
2256
|
-
#
|
2257
|
-
#
|
2319
|
+
# SERVICE
|
2320
|
+
#
|
2321
|
+
# : The service ID is returned in the `ResourceId` property.
|
2322
|
+
#
|
2323
|
+
# INSTANCE
|
2324
|
+
#
|
2325
|
+
# : The instance ID is returned in the `ResourceId` property.
|
2258
2326
|
# @return [Hash<String,String>]
|
2259
2327
|
#
|
2260
2328
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Operation AWS API Documentation
|
@@ -2403,7 +2471,7 @@ module Aws::ServiceDiscovery
|
|
2403
2471
|
#
|
2404
2472
|
# {
|
2405
2473
|
# service_id: "ResourceId", # required
|
2406
|
-
# instance_id: "
|
2474
|
+
# instance_id: "InstanceId", # required
|
2407
2475
|
# creator_request_id: "ResourceId",
|
2408
2476
|
# attributes: { # required
|
2409
2477
|
# "AttrKey" => "AttrValue",
|
@@ -2470,101 +2538,102 @@ module Aws::ServiceDiscovery
|
|
2470
2538
|
#
|
2471
2539
|
# Supported attribute keys include the following:
|
2472
2540
|
#
|
2473
|
-
#
|
2541
|
+
# AWS\_ALIAS\_DNS\_NAME
|
2474
2542
|
#
|
2475
|
-
# If you want AWS Cloud Map to create an Amazon Route 53 alias
|
2476
|
-
#
|
2477
|
-
#
|
2478
|
-
#
|
2479
|
-
#
|
2543
|
+
# : If you want AWS Cloud Map to create an Amazon Route 53 alias
|
2544
|
+
# record that routes traffic to an Elastic Load Balancing load
|
2545
|
+
# balancer, specify the DNS name that is associated with the load
|
2546
|
+
# balancer. For information about how to get the DNS name, see
|
2547
|
+
# "DNSName" in the topic [AliasTarget][1] in the *Route 53 API
|
2548
|
+
# Reference*.
|
2480
2549
|
#
|
2481
|
-
#
|
2550
|
+
# Note the following:
|
2482
2551
|
#
|
2483
|
-
#
|
2484
|
-
#
|
2485
|
-
#
|
2552
|
+
# * The configuration for the service that is specified by
|
2553
|
+
# `ServiceId` must include settings for an `A` record, an `AAAA`
|
2554
|
+
# record, or both.
|
2486
2555
|
#
|
2487
|
-
#
|
2488
|
-
#
|
2556
|
+
# * In the service that is specified by `ServiceId`, the value of
|
2557
|
+
# `RoutingPolicy` must be `WEIGHTED`.
|
2489
2558
|
#
|
2490
|
-
#
|
2491
|
-
#
|
2492
|
-
#
|
2493
|
-
#
|
2559
|
+
# * If the service that is specified by `ServiceId` includes
|
2560
|
+
# `HealthCheckConfig` settings, AWS Cloud Map will create the
|
2561
|
+
# Route 53 health check, but it doesn't associate the health
|
2562
|
+
# check with the alias record.
|
2494
2563
|
#
|
2495
|
-
#
|
2496
|
-
#
|
2497
|
-
#
|
2564
|
+
# * Auto naming currently doesn't support creating alias records
|
2565
|
+
# that route traffic to AWS resources other than Elastic Load
|
2566
|
+
# Balancing load balancers.
|
2498
2567
|
#
|
2499
|
-
#
|
2500
|
-
#
|
2568
|
+
# * If you specify a value for `AWS_ALIAS_DNS_NAME`, don't specify
|
2569
|
+
# values for any of the `AWS_INSTANCE` attributes.
|
2501
2570
|
#
|
2502
|
-
#
|
2571
|
+
# AWS\_EC2\_INSTANCE\_ID
|
2503
2572
|
#
|
2504
|
-
# *HTTP namespaces only.* The Amazon EC2 instance ID for the
|
2505
|
-
#
|
2506
|
-
#
|
2507
|
-
#
|
2508
|
-
#
|
2509
|
-
#
|
2573
|
+
# : *HTTP namespaces only.* The Amazon EC2 instance ID for the
|
2574
|
+
# instance. If the `AWS_EC2_INSTANCE_ID` attribute is specified,
|
2575
|
+
# then the only other attribute that can be specified is
|
2576
|
+
# `AWS_INIT_HEALTH_STATUS`. When the `AWS_EC2_INSTANCE_ID` attribute
|
2577
|
+
# is specified, then the `AWS_INSTANCE_IPV4` attribute will be
|
2578
|
+
# filled out with the primary private IPv4 address.
|
2510
2579
|
#
|
2511
|
-
#
|
2580
|
+
# AWS\_INIT\_HEALTH\_STATUS
|
2512
2581
|
#
|
2513
|
-
# If the service configuration includes `HealthCheckCustomConfig`,
|
2514
|
-
#
|
2515
|
-
#
|
2516
|
-
#
|
2517
|
-
#
|
2582
|
+
# : If the service configuration includes `HealthCheckCustomConfig`,
|
2583
|
+
# you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the
|
2584
|
+
# initial status of the custom health check, `HEALTHY` or
|
2585
|
+
# `UNHEALTHY`. If you don't specify a value for
|
2586
|
+
# `AWS_INIT_HEALTH_STATUS`, the initial status is `HEALTHY`.
|
2518
2587
|
#
|
2519
|
-
#
|
2588
|
+
# AWS\_INSTANCE\_CNAME
|
2520
2589
|
#
|
2521
|
-
# If the service configuration includes a `CNAME` record, the domain
|
2522
|
-
#
|
2523
|
-
#
|
2590
|
+
# : 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`.
|
2524
2593
|
#
|
2525
|
-
#
|
2526
|
-
#
|
2594
|
+
# This value is required if the service specified by `ServiceId`
|
2595
|
+
# includes settings for an `CNAME` record.
|
2527
2596
|
#
|
2528
|
-
#
|
2597
|
+
# AWS\_INSTANCE\_IPV4
|
2529
2598
|
#
|
2530
|
-
# If the service configuration includes an `A` record, the IPv4
|
2531
|
-
#
|
2532
|
-
#
|
2599
|
+
# : If the service configuration includes an `A` record, the IPv4
|
2600
|
+
# address that you want Route 53 to return in response to DNS
|
2601
|
+
# queries, for example, `192.0.2.44`.
|
2533
2602
|
#
|
2534
|
-
#
|
2535
|
-
#
|
2536
|
-
#
|
2537
|
-
#
|
2603
|
+
# This value is required if the service specified by `ServiceId`
|
2604
|
+
# includes settings for an `A` record. If the service includes
|
2605
|
+
# settings for an `SRV` record, you must specify a value for
|
2606
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
2538
2607
|
#
|
2539
|
-
#
|
2608
|
+
# AWS\_INSTANCE\_IPV6
|
2540
2609
|
#
|
2541
|
-
# If the service configuration includes an `AAAA` record, the IPv6
|
2542
|
-
#
|
2543
|
-
#
|
2610
|
+
# : If the service configuration includes an `AAAA` record, the IPv6
|
2611
|
+
# address that you want Route 53 to return in response to DNS
|
2612
|
+
# queries, for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345`.
|
2544
2613
|
#
|
2545
|
-
#
|
2546
|
-
#
|
2547
|
-
#
|
2548
|
-
#
|
2614
|
+
# This value is required if the service specified by `ServiceId`
|
2615
|
+
# includes settings for an `AAAA` record. If the service includes
|
2616
|
+
# settings for an `SRV` record, you must specify a value for
|
2617
|
+
# `AWS_INSTANCE_IPV4`, `AWS_INSTANCE_IPV6`, or both.
|
2549
2618
|
#
|
2550
|
-
#
|
2619
|
+
# AWS\_INSTANCE\_PORT
|
2551
2620
|
#
|
2552
|
-
# If the service includes an `SRV` record, the value that you want
|
2553
|
-
#
|
2621
|
+
# : If the service includes an `SRV` record, the value that you want
|
2622
|
+
# Route 53 to return for the port.
|
2554
2623
|
#
|
2555
|
-
#
|
2556
|
-
#
|
2624
|
+
# If the service includes `HealthCheckConfig`, the port on the
|
2625
|
+
# endpoint that you want Route 53 to send requests to.
|
2557
2626
|
#
|
2558
|
-
#
|
2559
|
-
#
|
2627
|
+
# This value is required if you specified settings for an `SRV`
|
2628
|
+
# record or a Route 53 health check when you created the service.
|
2560
2629
|
#
|
2561
|
-
#
|
2630
|
+
# Custom attributes
|
2562
2631
|
#
|
2563
|
-
# You can add up to 30 custom attributes. For each key-value pair,
|
2564
|
-
#
|
2565
|
-
#
|
2566
|
-
#
|
2567
|
-
#
|
2632
|
+
# : You can add up to 30 custom attributes. For each key-value pair,
|
2633
|
+
# the maximum length of the attribute name is 255 characters, and
|
2634
|
+
# the maximum length of the attribute value is 1,024 characters. The
|
2635
|
+
# total size of all provided attributes (sum of all keys and values)
|
2636
|
+
# must not exceed 5,000 characters.
|
2568
2637
|
#
|
2569
2638
|
#
|
2570
2639
|
#
|
@@ -2749,9 +2818,9 @@ module Aws::ServiceDiscovery
|
|
2749
2818
|
#
|
2750
2819
|
# @!attribute [rw] creator_request_id
|
2751
2820
|
# A unique string that identifies the request and that allows failed
|
2752
|
-
# requests to be retried without the risk of
|
2821
|
+
# requests to be retried without the risk of running the operation
|
2753
2822
|
# twice. `CreatorRequestId` can be any unique string, for example, a
|
2754
|
-
# date/
|
2823
|
+
# date/timestamp.
|
2755
2824
|
# @return [String]
|
2756
2825
|
#
|
2757
2826
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/Service AWS API Documentation
|
@@ -2824,81 +2893,15 @@ module Aws::ServiceDiscovery
|
|
2824
2893
|
# @return [String]
|
2825
2894
|
#
|
2826
2895
|
# @!attribute [rw] dns_config
|
2827
|
-
#
|
2828
|
-
#
|
2829
|
-
# instance.
|
2896
|
+
# Information about the Route 53 DNS records that you want AWS Cloud
|
2897
|
+
# Map to create when you register an instance.
|
2830
2898
|
# @return [Types::DnsConfigChange]
|
2831
2899
|
#
|
2832
2900
|
# @!attribute [rw] health_check_config
|
2833
|
-
# *Public DNS and HTTP namespaces only.*
|
2834
|
-
#
|
2835
|
-
#
|
2836
|
-
#
|
2837
|
-
#
|
2838
|
-
# If you specify a health check configuration, you can specify either
|
2839
|
-
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
2840
|
-
#
|
2841
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
2842
|
-
# endpoint. For information about pricing for health checks, see
|
2843
|
-
# [Amazon Route 53 Pricing][1].
|
2844
|
-
#
|
2845
|
-
# Note the following about configuring health checks.
|
2846
|
-
#
|
2847
|
-
# <b> <code>A</code> and <code>AAAA</code> records</b>
|
2848
|
-
#
|
2849
|
-
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
2850
|
-
# records, AWS Cloud Map creates a health check that uses the IPv4
|
2851
|
-
# address to check the health of the resource. If the endpoint that is
|
2852
|
-
# specified by the IPv4 address is unhealthy, Route 53 considers both
|
2853
|
-
# the `A` and `AAAA` records to be unhealthy.
|
2854
|
-
#
|
2855
|
-
# <b> <code>CNAME</code> records</b>
|
2856
|
-
#
|
2857
|
-
# You can't specify settings for `HealthCheckConfig` when the
|
2858
|
-
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
2859
|
-
# `CreateService` request will fail with an `InvalidInput` error.
|
2860
|
-
#
|
2861
|
-
# **Request interval**
|
2862
|
-
#
|
2863
|
-
# A Route 53 health checker in each health-checking region sends a
|
2864
|
-
# health check request to an endpoint every 30 seconds. On average,
|
2865
|
-
# your endpoint receives a health check request about every two
|
2866
|
-
# seconds. However, health checkers don't coordinate with one
|
2867
|
-
# another, so you'll sometimes see several requests per second
|
2868
|
-
# followed by a few seconds with no health checks at all.
|
2869
|
-
#
|
2870
|
-
# **Health checking regions**
|
2871
|
-
#
|
2872
|
-
# Health checkers perform checks from all Route 53 health-checking
|
2873
|
-
# regions. For a list of the current regions, see [Regions][2].
|
2874
|
-
#
|
2875
|
-
# **Alias records**
|
2876
|
-
#
|
2877
|
-
# When you register an instance, if you include the
|
2878
|
-
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route 53
|
2879
|
-
# alias record. Note the following:
|
2880
|
-
#
|
2881
|
-
# * Route 53 automatically sets `EvaluateTargetHealth` to true for
|
2882
|
-
# alias records. When `EvaluateTargetHealth` is true, the alias
|
2883
|
-
# record inherits the health of the referenced AWS resource. such as
|
2884
|
-
# an ELB load balancer. For more information, see
|
2885
|
-
# [EvaluateTargetHealth][3].
|
2886
|
-
#
|
2887
|
-
# * If you include `HealthCheckConfig` and then use the service to
|
2888
|
-
# register an instance that creates an alias record, Route 53
|
2889
|
-
# doesn't create the health check.
|
2890
|
-
#
|
2891
|
-
# **Charges for health checks**
|
2892
|
-
#
|
2893
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
2894
|
-
# endpoint. For information about pricing for health checks, see
|
2895
|
-
# [Amazon Route 53 Pricing][1].
|
2896
|
-
#
|
2897
|
-
#
|
2898
|
-
#
|
2899
|
-
# [1]: http://aws.amazon.com/route53/pricing/
|
2900
|
-
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions
|
2901
|
-
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth
|
2901
|
+
# *Public DNS and HTTP namespaces only.* Settings for an optional
|
2902
|
+
# health check. If you specify settings for a health check, AWS Cloud
|
2903
|
+
# Map associates the health check with the records that you specify in
|
2904
|
+
# `DnsConfig`.
|
2902
2905
|
# @return [Types::HealthCheckConfig]
|
2903
2906
|
#
|
2904
2907
|
# @see http://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ServiceChange AWS API Documentation
|
@@ -3017,88 +3020,22 @@ module Aws::ServiceDiscovery
|
|
3017
3020
|
# @return [Integer]
|
3018
3021
|
#
|
3019
3022
|
# @!attribute [rw] dns_config
|
3020
|
-
#
|
3021
|
-
#
|
3022
|
-
# an instance.
|
3023
|
+
# Information about the Route 53 DNS records that you want AWS Cloud
|
3024
|
+
# Map to create when you register an instance.
|
3023
3025
|
# @return [Types::DnsConfig]
|
3024
3026
|
#
|
3025
3027
|
# @!attribute [rw] health_check_config
|
3026
|
-
# *Public DNS and HTTP namespaces only.*
|
3027
|
-
#
|
3028
|
-
#
|
3029
|
-
#
|
3030
|
-
#
|
3031
|
-
# If you specify a health check configuration, you can specify either
|
3032
|
-
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
3033
|
-
#
|
3034
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
3035
|
-
# endpoint. For information about pricing for health checks, see
|
3036
|
-
# [Amazon Route 53 Pricing][1].
|
3037
|
-
#
|
3038
|
-
# Note the following about configuring health checks.
|
3039
|
-
#
|
3040
|
-
# <b> <code>A</code> and <code>AAAA</code> records</b>
|
3041
|
-
#
|
3042
|
-
# If `DnsConfig` includes configurations for both `A` and `AAAA`
|
3043
|
-
# records, AWS Cloud Map creates a health check that uses the IPv4
|
3044
|
-
# address to check the health of the resource. If the endpoint that is
|
3045
|
-
# specified by the IPv4 address is unhealthy, Route 53 considers both
|
3046
|
-
# the `A` and `AAAA` records to be unhealthy.
|
3047
|
-
#
|
3048
|
-
# <b> <code>CNAME</code> records</b>
|
3049
|
-
#
|
3050
|
-
# You can't specify settings for `HealthCheckConfig` when the
|
3051
|
-
# `DNSConfig` includes `CNAME` for the value of `Type`. If you do, the
|
3052
|
-
# `CreateService` request will fail with an `InvalidInput` error.
|
3053
|
-
#
|
3054
|
-
# **Request interval**
|
3055
|
-
#
|
3056
|
-
# A Route 53 health checker in each health-checking region sends a
|
3057
|
-
# health check request to an endpoint every 30 seconds. On average,
|
3058
|
-
# your endpoint receives a health check request about every two
|
3059
|
-
# seconds. However, health checkers don't coordinate with one
|
3060
|
-
# another, so you'll sometimes see several requests per second
|
3061
|
-
# followed by a few seconds with no health checks at all.
|
3062
|
-
#
|
3063
|
-
# **Health checking regions**
|
3064
|
-
#
|
3065
|
-
# Health checkers perform checks from all Route 53 health-checking
|
3066
|
-
# regions. For a list of the current regions, see [Regions][2].
|
3067
|
-
#
|
3068
|
-
# **Alias records**
|
3069
|
-
#
|
3070
|
-
# When you register an instance, if you include the
|
3071
|
-
# `AWS_ALIAS_DNS_NAME` attribute, AWS Cloud Map creates a Route 53
|
3072
|
-
# alias record. Note the following:
|
3073
|
-
#
|
3074
|
-
# * Route 53 automatically sets `EvaluateTargetHealth` to true for
|
3075
|
-
# alias records. When `EvaluateTargetHealth` is true, the alias
|
3076
|
-
# record inherits the health of the referenced AWS resource. such as
|
3077
|
-
# an ELB load balancer. For more information, see
|
3078
|
-
# [EvaluateTargetHealth][3].
|
3079
|
-
#
|
3080
|
-
# * If you include `HealthCheckConfig` and then use the service to
|
3081
|
-
# register an instance that creates an alias record, Route 53
|
3082
|
-
# doesn't create the health check.
|
3083
|
-
#
|
3084
|
-
# **Charges for health checks**
|
3085
|
-
#
|
3086
|
-
# Health checks are basic Route 53 health checks that monitor an AWS
|
3087
|
-
# endpoint. For information about pricing for health checks, see
|
3088
|
-
# [Amazon Route 53 Pricing][1].
|
3089
|
-
#
|
3090
|
-
#
|
3091
|
-
#
|
3092
|
-
# [1]: http://aws.amazon.com/route53/pricing/
|
3093
|
-
# [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions
|
3094
|
-
# [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth
|
3028
|
+
# *Public DNS and HTTP namespaces only.* Settings for an optional
|
3029
|
+
# health check. If you specify settings for a health check, AWS Cloud
|
3030
|
+
# Map associates the health check with the records that you specify in
|
3031
|
+
# `DnsConfig`.
|
3095
3032
|
# @return [Types::HealthCheckConfig]
|
3096
3033
|
#
|
3097
3034
|
# @!attribute [rw] health_check_custom_config
|
3098
|
-
#
|
3099
|
-
#
|
3100
|
-
#
|
3101
|
-
#
|
3035
|
+
# Information about an optional custom health check. A custom health
|
3036
|
+
# check, which requires that you use a third-party health checker to
|
3037
|
+
# evaluate the health of your resources, is useful in the following
|
3038
|
+
# circumstances:
|
3102
3039
|
#
|
3103
3040
|
# * You can't use a health check that is defined by
|
3104
3041
|
# `HealthCheckConfig` because the resource isn't available over the
|
@@ -3111,48 +3048,6 @@ module Aws::ServiceDiscovery
|
|
3111
3048
|
#
|
3112
3049
|
# If you specify a health check configuration, you can specify either
|
3113
3050
|
# `HealthCheckCustomConfig` or `HealthCheckConfig` but not both.
|
3114
|
-
#
|
3115
|
-
# To change the status of a custom health check, submit an
|
3116
|
-
# `UpdateInstanceCustomHealthStatus` request. AWS Cloud Map doesn't
|
3117
|
-
# monitor the status of the resource, it just keeps a record of the
|
3118
|
-
# status specified in the most recent
|
3119
|
-
# `UpdateInstanceCustomHealthStatus` request.
|
3120
|
-
#
|
3121
|
-
# Here's how custom health checks work:
|
3122
|
-
#
|
3123
|
-
# 1. You create a service and specify a value for `FailureThreshold`.
|
3124
|
-
#
|
3125
|
-
# The failure threshold indicates the number of 30-second
|
3126
|
-
# intervals you want AWS Cloud Map to wait between the time that
|
3127
|
-
# your application sends an [UpdateInstanceCustomHealthStatus][1]
|
3128
|
-
# request and the time that AWS Cloud Map stops routing internet
|
3129
|
-
# traffic to the corresponding resource.
|
3130
|
-
#
|
3131
|
-
# 2. You register an instance.
|
3132
|
-
#
|
3133
|
-
# 3. You configure a third-party health checker to monitor the
|
3134
|
-
# resource that is associated with the new instance.
|
3135
|
-
#
|
3136
|
-
# <note markdown="1"> AWS Cloud Map doesn't check the health of the resource
|
3137
|
-
# directly.
|
3138
|
-
#
|
3139
|
-
# </note>
|
3140
|
-
#
|
3141
|
-
# 4. The third-party health-checker determines that the resource is
|
3142
|
-
# unhealthy and notifies your application.
|
3143
|
-
#
|
3144
|
-
# 5. Your application submits an `UpdateInstanceCustomHealthStatus`
|
3145
|
-
# request.
|
3146
|
-
#
|
3147
|
-
# 6. AWS Cloud Map waits for (`FailureThreshold` x 30) seconds.
|
3148
|
-
#
|
3149
|
-
# 7. If another `UpdateInstanceCustomHealthStatus` request doesn't
|
3150
|
-
# arrive during that time to change the status back to healthy,
|
3151
|
-
# AWS Cloud Map stops routing traffic to the resource.
|
3152
|
-
#
|
3153
|
-
#
|
3154
|
-
#
|
3155
|
-
# [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html
|
3156
3051
|
# @return [Types::HealthCheckCustomConfig]
|
3157
3052
|
#
|
3158
3053
|
# @!attribute [rw] create_date
|