@aws-sdk/client-servicediscovery 3.554.0 → 3.560.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -6
- package/dist-types/ServiceDiscovery.d.ts +5 -6
- package/dist-types/ServiceDiscoveryClient.d.ts +5 -6
- package/dist-types/commands/CreateHttpNamespaceCommand.d.ts +9 -12
- package/dist-types/commands/CreatePrivateDnsNamespaceCommand.d.ts +11 -14
- package/dist-types/commands/CreatePublicDnsNamespaceCommand.d.ts +13 -14
- package/dist-types/commands/CreateServiceCommand.d.ts +10 -12
- package/dist-types/commands/DeleteNamespaceCommand.d.ts +6 -7
- package/dist-types/commands/DeleteServiceCommand.d.ts +6 -7
- package/dist-types/commands/DeregisterInstanceCommand.d.ts +8 -9
- package/dist-types/commands/DiscoverInstancesCommand.d.ts +8 -10
- package/dist-types/commands/DiscoverInstancesRevisionCommand.d.ts +5 -6
- package/dist-types/commands/GetInstanceCommand.d.ts +4 -5
- package/dist-types/commands/GetInstancesHealthStatusCommand.d.ts +8 -10
- package/dist-types/commands/GetNamespaceCommand.d.ts +2 -3
- package/dist-types/commands/GetOperationCommand.d.ts +2 -3
- package/dist-types/commands/GetServiceCommand.d.ts +2 -3
- package/dist-types/commands/ListInstancesCommand.d.ts +3 -5
- package/dist-types/commands/ListNamespacesCommand.d.ts +2 -3
- package/dist-types/commands/ListOperationsCommand.d.ts +2 -3
- package/dist-types/commands/ListServicesCommand.d.ts +3 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -3
- package/dist-types/commands/RegisterInstanceCommand.d.ts +22 -28
- package/dist-types/commands/TagResourceCommand.d.ts +4 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -3
- package/dist-types/commands/UpdateHttpNamespaceCommand.d.ts +4 -5
- package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +10 -13
- package/dist-types/commands/UpdatePrivateDnsNamespaceCommand.d.ts +4 -5
- package/dist-types/commands/UpdatePublicDnsNamespaceCommand.d.ts +4 -5
- package/dist-types/commands/UpdateServiceCommand.d.ts +7 -10
- package/dist-types/index.d.ts +5 -6
- package/dist-types/models/models_0.d.ts +670 -741
- package/package.json +4 -4
|
@@ -11,8 +11,8 @@ export interface Tag {
|
|
|
11
11
|
*/
|
|
12
12
|
Key: string | undefined;
|
|
13
13
|
/**
|
|
14
|
-
* <p>The string value that's associated with the key of the tag. You can set the value of a tag
|
|
15
|
-
*
|
|
14
|
+
* <p>The string value that's associated with the key of the tag. You can set the value of a tag to an empty
|
|
15
|
+
* string, but you can't set the value of a tag to null.</p>
|
|
16
16
|
* @public
|
|
17
17
|
*/
|
|
18
18
|
Value: string | undefined;
|
|
@@ -27,10 +27,9 @@ export interface CreateHttpNamespaceRequest {
|
|
|
27
27
|
*/
|
|
28
28
|
Name: string | undefined;
|
|
29
29
|
/**
|
|
30
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* stamp).</p>
|
|
30
|
+
* <p>A unique string that identifies the request and that allows failed <code>CreateHttpNamespace</code>
|
|
31
|
+
* requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any
|
|
32
|
+
* unique string (for example, a date/time stamp).</p>
|
|
34
33
|
* @public
|
|
35
34
|
*/
|
|
36
35
|
CreatorRequestId?: string;
|
|
@@ -40,8 +39,8 @@ export interface CreateHttpNamespaceRequest {
|
|
|
40
39
|
*/
|
|
41
40
|
Description?: string;
|
|
42
41
|
/**
|
|
43
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
44
|
-
*
|
|
42
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you define.
|
|
43
|
+
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
45
44
|
* characters in length.</p>
|
|
46
45
|
* @public
|
|
47
46
|
*/
|
|
@@ -77,9 +76,8 @@ export declare class DuplicateRequest extends __BaseException {
|
|
|
77
76
|
constructor(opts: __ExceptionOptionType<DuplicateRequest, __BaseException>);
|
|
78
77
|
}
|
|
79
78
|
/**
|
|
80
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
81
|
-
*
|
|
82
|
-
* constraints.</p>
|
|
79
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value
|
|
80
|
+
* might be outside the allowed range, or a string value might exceed length constraints.</p>
|
|
83
81
|
* @public
|
|
84
82
|
*/
|
|
85
83
|
export declare class InvalidInput extends __BaseException {
|
|
@@ -115,8 +113,7 @@ export declare class NamespaceAlreadyExists extends __BaseException {
|
|
|
115
113
|
constructor(opts: __ExceptionOptionType<NamespaceAlreadyExists, __BaseException>);
|
|
116
114
|
}
|
|
117
115
|
/**
|
|
118
|
-
* <p>The resource can't be created because you've reached the quota on the number of
|
|
119
|
-
* resources.</p>
|
|
116
|
+
* <p>The resource can't be created because you've reached the quota on the number of resources.</p>
|
|
120
117
|
* @public
|
|
121
118
|
*/
|
|
122
119
|
export declare class ResourceLimitExceeded extends __BaseException {
|
|
@@ -129,8 +126,8 @@ export declare class ResourceLimitExceeded extends __BaseException {
|
|
|
129
126
|
constructor(opts: __ExceptionOptionType<ResourceLimitExceeded, __BaseException>);
|
|
130
127
|
}
|
|
131
128
|
/**
|
|
132
|
-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
133
|
-
*
|
|
129
|
+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a
|
|
130
|
+
* resource is 50.</p>
|
|
134
131
|
* @public
|
|
135
132
|
*/
|
|
136
133
|
export declare class TooManyTagsException extends __BaseException {
|
|
@@ -148,41 +145,40 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
148
145
|
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
149
146
|
}
|
|
150
147
|
/**
|
|
151
|
-
* <p>Start of Authority
|
|
152
|
-
*
|
|
148
|
+
* <p>Start of Authority (SOA) properties
|
|
149
|
+
* for a public or private DNS namespace.</p>
|
|
153
150
|
* @public
|
|
154
151
|
*/
|
|
155
152
|
export interface SOA {
|
|
156
153
|
/**
|
|
157
|
-
* <p>The time to live
|
|
158
|
-
*
|
|
154
|
+
* <p>The time to live (TTL) for purposes
|
|
155
|
+
* of negative caching.</p>
|
|
159
156
|
* @public
|
|
160
157
|
*/
|
|
161
158
|
TTL: number | undefined;
|
|
162
159
|
}
|
|
163
160
|
/**
|
|
164
|
-
* <p>DNS properties for
|
|
165
|
-
*
|
|
161
|
+
* <p>DNS properties for the private DNS
|
|
162
|
+
* namespace.</p>
|
|
166
163
|
* @public
|
|
167
164
|
*/
|
|
168
165
|
export interface PrivateDnsPropertiesMutable {
|
|
169
166
|
/**
|
|
170
|
-
* <p>Fields for the Start
|
|
171
|
-
*
|
|
172
|
-
* namespace.</p>
|
|
167
|
+
* <p>Fields for the Start of Authority
|
|
168
|
+
* (SOA) record for the hosted zone for the private DNS namespace.</p>
|
|
173
169
|
* @public
|
|
174
170
|
*/
|
|
175
171
|
SOA: SOA | undefined;
|
|
176
172
|
}
|
|
177
173
|
/**
|
|
178
|
-
* <p>DNS properties for
|
|
179
|
-
*
|
|
174
|
+
* <p>DNS properties for the private DNS
|
|
175
|
+
* namespace.</p>
|
|
180
176
|
* @public
|
|
181
177
|
*/
|
|
182
178
|
export interface PrivateDnsNamespaceProperties {
|
|
183
179
|
/**
|
|
184
|
-
* <p>DNS properties for
|
|
185
|
-
*
|
|
180
|
+
* <p>DNS properties for the private DNS
|
|
181
|
+
* namespace.</p>
|
|
186
182
|
* @public
|
|
187
183
|
*/
|
|
188
184
|
DnsProperties: PrivateDnsPropertiesMutable | undefined;
|
|
@@ -192,17 +188,15 @@ export interface PrivateDnsNamespaceProperties {
|
|
|
192
188
|
*/
|
|
193
189
|
export interface CreatePrivateDnsNamespaceRequest {
|
|
194
190
|
/**
|
|
195
|
-
* <p>The name that you want to assign to this namespace. When you create a private DNS namespace,
|
|
196
|
-
*
|
|
197
|
-
* namespace.</p>
|
|
191
|
+
* <p>The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map
|
|
192
|
+
* automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.</p>
|
|
198
193
|
* @public
|
|
199
194
|
*/
|
|
200
195
|
Name: string | undefined;
|
|
201
196
|
/**
|
|
202
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
* date/timestamp).</p>
|
|
197
|
+
* <p>A unique string that identifies the request and that allows failed <code>CreatePrivateDnsNamespace</code>
|
|
198
|
+
* requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any
|
|
199
|
+
* unique string (for example, a date/timestamp).</p>
|
|
206
200
|
* @public
|
|
207
201
|
*/
|
|
208
202
|
CreatorRequestId?: string;
|
|
@@ -217,15 +211,15 @@ export interface CreatePrivateDnsNamespaceRequest {
|
|
|
217
211
|
*/
|
|
218
212
|
Vpc: string | undefined;
|
|
219
213
|
/**
|
|
220
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
221
|
-
*
|
|
214
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you define.
|
|
215
|
+
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
222
216
|
* characters in length.</p>
|
|
223
217
|
* @public
|
|
224
218
|
*/
|
|
225
219
|
Tags?: Tag[];
|
|
226
220
|
/**
|
|
227
|
-
* <p>Properties for the
|
|
228
|
-
*
|
|
221
|
+
* <p>Properties for the private DNS
|
|
222
|
+
* namespace.</p>
|
|
229
223
|
* @public
|
|
230
224
|
*/
|
|
231
225
|
Properties?: PrivateDnsNamespaceProperties;
|
|
@@ -242,27 +236,27 @@ export interface CreatePrivateDnsNamespaceResponse {
|
|
|
242
236
|
OperationId?: string;
|
|
243
237
|
}
|
|
244
238
|
/**
|
|
245
|
-
* <p>DNS properties for
|
|
246
|
-
*
|
|
239
|
+
* <p>DNS properties for the public DNS
|
|
240
|
+
* namespace.</p>
|
|
247
241
|
* @public
|
|
248
242
|
*/
|
|
249
243
|
export interface PublicDnsPropertiesMutable {
|
|
250
244
|
/**
|
|
251
|
-
* <p>Start of Authority
|
|
252
|
-
*
|
|
245
|
+
* <p>Start of Authority (SOA) record for
|
|
246
|
+
* the hosted zone for the public DNS namespace.</p>
|
|
253
247
|
* @public
|
|
254
248
|
*/
|
|
255
249
|
SOA: SOA | undefined;
|
|
256
250
|
}
|
|
257
251
|
/**
|
|
258
|
-
* <p>DNS properties for
|
|
259
|
-
*
|
|
252
|
+
* <p>DNS properties for the public DNS
|
|
253
|
+
* namespace.</p>
|
|
260
254
|
* @public
|
|
261
255
|
*/
|
|
262
256
|
export interface PublicDnsNamespaceProperties {
|
|
263
257
|
/**
|
|
264
|
-
* <p>DNS properties for
|
|
265
|
-
*
|
|
258
|
+
* <p>DNS properties for the public DNS
|
|
259
|
+
* namespace.</p>
|
|
266
260
|
* @public
|
|
267
261
|
*/
|
|
268
262
|
DnsProperties: PublicDnsPropertiesMutable | undefined;
|
|
@@ -274,17 +268,15 @@ export interface CreatePublicDnsNamespaceRequest {
|
|
|
274
268
|
/**
|
|
275
269
|
* <p>The name that you want to assign to this namespace.</p>
|
|
276
270
|
* <note>
|
|
277
|
-
* <p>Do not include sensitive information in the name. The name is publicly available using DNS
|
|
278
|
-
* queries.</p>
|
|
271
|
+
* <p>Do not include sensitive information in the name. The name is publicly available using DNS queries.</p>
|
|
279
272
|
* </note>
|
|
280
273
|
* @public
|
|
281
274
|
*/
|
|
282
275
|
Name: string | undefined;
|
|
283
276
|
/**
|
|
284
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
* date/timestamp).</p>
|
|
277
|
+
* <p>A unique string that identifies the request and that allows failed <code>CreatePublicDnsNamespace</code>
|
|
278
|
+
* requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any
|
|
279
|
+
* unique string (for example, a date/timestamp).</p>
|
|
288
280
|
* @public
|
|
289
281
|
*/
|
|
290
282
|
CreatorRequestId?: string;
|
|
@@ -294,15 +286,15 @@ export interface CreatePublicDnsNamespaceRequest {
|
|
|
294
286
|
*/
|
|
295
287
|
Description?: string;
|
|
296
288
|
/**
|
|
297
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
298
|
-
*
|
|
289
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you define.
|
|
290
|
+
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
299
291
|
* characters in length.</p>
|
|
300
292
|
* @public
|
|
301
293
|
*/
|
|
302
294
|
Tags?: Tag[];
|
|
303
295
|
/**
|
|
304
|
-
* <p>Properties for the
|
|
305
|
-
*
|
|
296
|
+
* <p>Properties for the public DNS
|
|
297
|
+
* namespace.</p>
|
|
306
298
|
* @public
|
|
307
299
|
*/
|
|
308
300
|
Properties?: PublicDnsNamespaceProperties;
|
|
@@ -312,8 +304,8 @@ export interface CreatePublicDnsNamespaceRequest {
|
|
|
312
304
|
*/
|
|
313
305
|
export interface CreatePublicDnsNamespaceResponse {
|
|
314
306
|
/**
|
|
315
|
-
* <p>A value that you can use to determine whether the request completed successfully. To get the
|
|
316
|
-
*
|
|
307
|
+
* <p>A value that you can use to determine whether the request completed successfully. To get the status of the
|
|
308
|
+
* operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
|
|
317
309
|
* @public
|
|
318
310
|
*/
|
|
319
311
|
OperationId?: string;
|
|
@@ -333,15 +325,14 @@ export declare const RecordType: {
|
|
|
333
325
|
*/
|
|
334
326
|
export type RecordType = (typeof RecordType)[keyof typeof RecordType];
|
|
335
327
|
/**
|
|
336
|
-
* <p>A complex type that contains information about the Route 53 DNS records that you want
|
|
337
|
-
*
|
|
328
|
+
* <p>A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create
|
|
329
|
+
* when you register an instance.</p>
|
|
338
330
|
* @public
|
|
339
331
|
*/
|
|
340
332
|
export interface DnsRecord {
|
|
341
333
|
/**
|
|
342
|
-
* <p>The type of the resource, which indicates the type of value that Route 53 returns in response
|
|
343
|
-
*
|
|
344
|
-
* combinations:</p>
|
|
334
|
+
* <p>The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.
|
|
335
|
+
* You can specify values for <code>Type</code> in the following combinations:</p>
|
|
345
336
|
* <ul>
|
|
346
337
|
* <li>
|
|
347
338
|
* <p>
|
|
@@ -381,10 +372,10 @@ export interface DnsRecord {
|
|
|
381
372
|
* </p>
|
|
382
373
|
* </li>
|
|
383
374
|
* </ul>
|
|
384
|
-
* <p>If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
|
|
385
|
-
*
|
|
386
|
-
* <p>You specify other settings, such as the IP address for <code>A</code> and <code>AAAA</code>
|
|
387
|
-
*
|
|
375
|
+
* <p>If you want Cloud Map to create a Route 53 alias record when you register an instance, specify <code>A</code>
|
|
376
|
+
* or <code>AAAA</code> for <code>Type</code>.</p>
|
|
377
|
+
* <p>You specify other settings, such as the IP address for <code>A</code> and <code>AAAA</code> records, when
|
|
378
|
+
* you register an instance. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a>.</p>
|
|
388
379
|
* <p>The following values are supported:</p>
|
|
389
380
|
* <dl>
|
|
390
381
|
* <dt>A</dt>
|
|
@@ -398,49 +389,44 @@ export interface DnsRecord {
|
|
|
398
389
|
* </dd>
|
|
399
390
|
* <dt>CNAME</dt>
|
|
400
391
|
* <dd>
|
|
401
|
-
* <p>Route 53 returns the domain name of the resource, such as www.example.com. Note the
|
|
402
|
-
* following:</p>
|
|
392
|
+
* <p>Route 53 returns the domain name of the resource, such as www.example.com. Note the following:</p>
|
|
403
393
|
* <ul>
|
|
404
394
|
* <li>
|
|
405
|
-
* <p>You specify the domain name that you want to route traffic to when you register an
|
|
406
|
-
*
|
|
395
|
+
* <p>You specify the domain name that you want to route traffic to when you register an instance. For more
|
|
396
|
+
* information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes">Attributes</a> in the topic <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a>.</p>
|
|
407
397
|
* </li>
|
|
408
398
|
* <li>
|
|
409
|
-
* <p>You must specify <code>WEIGHTED</code> for the value of
|
|
410
|
-
* <code>RoutingPolicy</code>.</p>
|
|
399
|
+
* <p>You must specify <code>WEIGHTED</code> for the value of <code>RoutingPolicy</code>.</p>
|
|
411
400
|
* </li>
|
|
412
401
|
* <li>
|
|
413
402
|
* <p>You can't specify both <code>CNAME</code> for <code>Type</code> and settings for
|
|
414
|
-
* <code>HealthCheckConfig</code>. If you do, the request will fail with an
|
|
415
|
-
*
|
|
403
|
+
* <code>HealthCheckConfig</code>. If you do, the request will fail with an <code>InvalidInput</code>
|
|
404
|
+
* error.</p>
|
|
416
405
|
* </li>
|
|
417
406
|
* </ul>
|
|
418
407
|
* </dd>
|
|
419
408
|
* <dt>SRV</dt>
|
|
420
409
|
* <dd>
|
|
421
|
-
* <p>Route 53 returns the value for an <code>SRV</code> record. The value for an <code>SRV</code>
|
|
422
|
-
*
|
|
410
|
+
* <p>Route 53 returns the value for an <code>SRV</code> record. The value for an <code>SRV</code> record uses
|
|
411
|
+
* the following values:</p>
|
|
423
412
|
* <p>
|
|
424
413
|
* <code>priority weight port service-hostname</code>
|
|
425
414
|
* </p>
|
|
426
415
|
* <p>Note the following about the values:</p>
|
|
427
416
|
* <ul>
|
|
428
417
|
* <li>
|
|
429
|
-
* <p>The values of <code>priority</code> and <code>weight</code> are both set to
|
|
430
|
-
*
|
|
418
|
+
* <p>The values of <code>priority</code> and <code>weight</code> are both set to <code>1</code> and can't
|
|
419
|
+
* be changed. </p>
|
|
431
420
|
* </li>
|
|
432
421
|
* <li>
|
|
433
422
|
* <p>The value of <code>port</code> comes from the value that you specify for the
|
|
434
|
-
* <code>AWS_INSTANCE_PORT</code> attribute when you submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a>
|
|
435
|
-
* request.</p>
|
|
423
|
+
* <code>AWS_INSTANCE_PORT</code> attribute when you submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request.</p>
|
|
436
424
|
* </li>
|
|
437
425
|
* <li>
|
|
438
|
-
* <p>The value of <code>service-hostname</code> is a concatenation of the following
|
|
439
|
-
* values:</p>
|
|
426
|
+
* <p>The value of <code>service-hostname</code> is a concatenation of the following values:</p>
|
|
440
427
|
* <ul>
|
|
441
428
|
* <li>
|
|
442
|
-
* <p>The value that you specify for <code>InstanceId</code> when you register an
|
|
443
|
-
* instance.</p>
|
|
429
|
+
* <p>The value that you specify for <code>InstanceId</code> when you register an instance.</p>
|
|
444
430
|
* </li>
|
|
445
431
|
* <li>
|
|
446
432
|
* <p>The name of the service.</p>
|
|
@@ -449,10 +435,9 @@ export interface DnsRecord {
|
|
|
449
435
|
* <p>The name of the namespace. </p>
|
|
450
436
|
* </li>
|
|
451
437
|
* </ul>
|
|
452
|
-
* <p>For example, if the value of <code>InstanceId</code> is <code>test</code>, the name of
|
|
453
|
-
*
|
|
454
|
-
* <code>
|
|
455
|
-
* following:</p>
|
|
438
|
+
* <p>For example, if the value of <code>InstanceId</code> is <code>test</code>, the name of the service is
|
|
439
|
+
* <code>backend</code>, and the name of the namespace is <code>example.com</code>, the value of
|
|
440
|
+
* <code>service-hostname</code> is the following:</p>
|
|
456
441
|
* <p>
|
|
457
442
|
* <code>test.backend.example.com</code>
|
|
458
443
|
* </p>
|
|
@@ -461,16 +446,16 @@ export interface DnsRecord {
|
|
|
461
446
|
* <p>If you specify settings for an <code>SRV</code> record, note the following:</p>
|
|
462
447
|
* <ul>
|
|
463
448
|
* <li>
|
|
464
|
-
* <p>If you specify values for <code>AWS_INSTANCE_IPV4</code>,
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
* You can ignore these records.</p>
|
|
449
|
+
* <p>If you specify values for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both in
|
|
450
|
+
* the <code>RegisterInstance</code> request, Cloud Map automatically creates <code>A</code> and/or
|
|
451
|
+
* <code>AAAA</code> records that have the same name as the value of <code>service-hostname</code> in the
|
|
452
|
+
* <code>SRV</code> record. You can ignore these records.</p>
|
|
469
453
|
* </li>
|
|
470
454
|
* <li>
|
|
471
|
-
* <p>If you're using a system that requires a specific <code>SRV</code> format, such as
|
|
472
|
-
*
|
|
473
|
-
* about how to specify the correct name
|
|
455
|
+
* <p>If you're using a system that requires a specific <code>SRV</code> format, such as HAProxy, see the
|
|
456
|
+
* <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name">Name</a> element
|
|
457
|
+
* in the documentation about <code>CreateService</code> for information about how to specify the correct name
|
|
458
|
+
* format.</p>
|
|
474
459
|
* </li>
|
|
475
460
|
* </ul>
|
|
476
461
|
* </dd>
|
|
@@ -479,14 +464,12 @@ export interface DnsRecord {
|
|
|
479
464
|
*/
|
|
480
465
|
Type: RecordType | undefined;
|
|
481
466
|
/**
|
|
482
|
-
* <p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this
|
|
483
|
-
* record.</p>
|
|
467
|
+
* <p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.</p>
|
|
484
468
|
* <note>
|
|
485
|
-
* <p>Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an
|
|
486
|
-
*
|
|
487
|
-
*
|
|
488
|
-
*
|
|
489
|
-
* to register instances that create either alias or non-alias records.</p>
|
|
469
|
+
* <p>Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record
|
|
470
|
+
* routes traffic to. If you include the <code>AWS_ALIAS_DNS_NAME</code> attribute when you submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request,
|
|
471
|
+
* the <code>TTL</code> value is ignored. Always specify a TTL for the service; you can use a service to register
|
|
472
|
+
* instances that create either alias or non-alias records.</p>
|
|
490
473
|
* </note>
|
|
491
474
|
* @public
|
|
492
475
|
*/
|
|
@@ -505,11 +488,11 @@ export declare const RoutingPolicy: {
|
|
|
505
488
|
*/
|
|
506
489
|
export type RoutingPolicy = (typeof RoutingPolicy)[keyof typeof RoutingPolicy];
|
|
507
490
|
/**
|
|
508
|
-
* <p>A complex type that contains information about the Amazon Route 53 DNS records that you want
|
|
509
|
-
*
|
|
491
|
+
* <p>A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create
|
|
492
|
+
* when you register an instance.</p>
|
|
510
493
|
* <important>
|
|
511
|
-
* <p>The record types of a service can only be changed by deleting the service and recreating it
|
|
512
|
-
*
|
|
494
|
+
* <p>The record types of a service can only be changed by deleting the service and recreating it with a new
|
|
495
|
+
* <code>Dnsconfig</code>.</p>
|
|
513
496
|
* </important>
|
|
514
497
|
* @public
|
|
515
498
|
*/
|
|
@@ -519,15 +502,16 @@ export interface DnsConfig {
|
|
|
519
502
|
*
|
|
520
503
|
* <p>
|
|
521
504
|
* <i>Use
|
|
522
|
-
* NamespaceId in <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html">Service</a>
|
|
505
|
+
* NamespaceId in <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html">Service</a>
|
|
506
|
+
* instead.</i>
|
|
523
507
|
* </p>
|
|
524
508
|
* <p>The ID of the namespace to use for DNS configuration.</p>
|
|
525
509
|
* @public
|
|
526
510
|
*/
|
|
527
511
|
NamespaceId?: string;
|
|
528
512
|
/**
|
|
529
|
-
* <p>The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates
|
|
530
|
-
*
|
|
513
|
+
* <p>The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you
|
|
514
|
+
* register an instance and specify this service.</p>
|
|
531
515
|
* <note>
|
|
532
516
|
* <p>If you want to use this service to register instances that create alias records, specify
|
|
533
517
|
* <code>WEIGHTED</code> for the routing policy.</p>
|
|
@@ -536,40 +520,38 @@ export interface DnsConfig {
|
|
|
536
520
|
* <dl>
|
|
537
521
|
* <dt>MULTIVALUE</dt>
|
|
538
522
|
* <dd>
|
|
539
|
-
* <p>If you define a health check for the service and the health check is healthy, Route 53
|
|
540
|
-
*
|
|
541
|
-
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
542
|
-
*
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
*
|
|
546
|
-
*
|
|
547
|
-
*
|
|
548
|
-
*
|
|
549
|
-
* Answer Routing</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
523
|
+
* <p>If you define a health check for the service and the health check is healthy, Route 53 returns the
|
|
524
|
+
* applicable value for up to eight instances.</p>
|
|
525
|
+
* <p>For example, suppose that the service includes configurations for one <code>A</code> record and a health
|
|
526
|
+
* check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up
|
|
527
|
+
* to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with
|
|
528
|
+
* the IP addresses for all of the healthy instances.</p>
|
|
529
|
+
* <p>If you don't define a health check for the service, Route 53 assumes that all instances are healthy and
|
|
530
|
+
* returns the values for up to eight instances.</p>
|
|
531
|
+
* <p>For more information about the multivalue routing policy, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue">Multivalue Answer
|
|
532
|
+
* Routing</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
550
533
|
* </dd>
|
|
551
534
|
* <dt>WEIGHTED</dt>
|
|
552
535
|
* <dd>
|
|
553
|
-
* <p>Route 53 returns the applicable value from one randomly selected instance from among the
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
557
|
-
*
|
|
558
|
-
*
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
*
|
|
563
|
-
*
|
|
564
|
-
* Routing</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
536
|
+
* <p>Route 53 returns the applicable value from one randomly selected instance from among the instances that you
|
|
537
|
+
* registered using the same service. Currently, all records have the same weight, so you can't route more or
|
|
538
|
+
* less traffic to any instances.</p>
|
|
539
|
+
* <p>For example, suppose that the service includes configurations for one <code>A</code> record and a health
|
|
540
|
+
* check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for
|
|
541
|
+
* one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds
|
|
542
|
+
* to DNS queries as if all of the instances were healthy.</p>
|
|
543
|
+
* <p>If you don't define a health check for the service, Route 53 assumes that all instances are healthy and
|
|
544
|
+
* returns the applicable value for one randomly selected instance.</p>
|
|
545
|
+
* <p>For more information about the weighted routing policy, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted">Weighted Routing</a> in
|
|
546
|
+
* the <i>Route 53 Developer Guide</i>.</p>
|
|
565
547
|
* </dd>
|
|
566
548
|
* </dl>
|
|
567
549
|
* @public
|
|
568
550
|
*/
|
|
569
551
|
RoutingPolicy?: RoutingPolicy;
|
|
570
552
|
/**
|
|
571
|
-
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 DNS record that you
|
|
572
|
-
*
|
|
553
|
+
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 DNS record that you want Cloud Map
|
|
554
|
+
* to create when you register an instance.</p>
|
|
573
555
|
* @public
|
|
574
556
|
*/
|
|
575
557
|
DnsRecords: DnsRecord[] | undefined;
|
|
@@ -589,73 +571,72 @@ export declare const HealthCheckType: {
|
|
|
589
571
|
export type HealthCheckType = (typeof HealthCheckType)[keyof typeof HealthCheckType];
|
|
590
572
|
/**
|
|
591
573
|
* <p>
|
|
592
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
593
|
-
*
|
|
594
|
-
*
|
|
574
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains settings for an
|
|
575
|
+
* optional health check. If you specify settings for a health check, Cloud Map associates the health check with
|
|
576
|
+
* the records that you specify in <code>DnsConfig</code>.</p>
|
|
595
577
|
* <important>
|
|
596
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
597
|
-
*
|
|
578
|
+
* <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code>
|
|
579
|
+
* or <code>HealthCheckConfig</code> but not both.</p>
|
|
598
580
|
* </important>
|
|
599
|
-
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For
|
|
600
|
-
*
|
|
581
|
+
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information
|
|
582
|
+
* about pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53
|
|
583
|
+
* Pricing</a>.</p>
|
|
601
584
|
* <p>Note the following about configuring health checks.</p>
|
|
602
585
|
* <dl>
|
|
603
586
|
* <dt>A and AAAA records</dt>
|
|
604
587
|
* <dd>
|
|
605
|
-
* <p>If <code>DnsConfig</code> includes configurations for both <code>A</code> and
|
|
606
|
-
*
|
|
607
|
-
*
|
|
608
|
-
*
|
|
609
|
-
* unhealthy. </p>
|
|
588
|
+
* <p>If <code>DnsConfig</code> includes configurations for both <code>A</code> and <code>AAAA</code> records,
|
|
589
|
+
* Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the
|
|
590
|
+
* endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the <code>A</code> and
|
|
591
|
+
* <code>AAAA</code> records to be unhealthy. </p>
|
|
610
592
|
* </dd>
|
|
611
593
|
* <dt>CNAME records</dt>
|
|
612
594
|
* <dd>
|
|
613
|
-
* <p>You can't specify settings for <code>HealthCheckConfig</code> when the
|
|
614
|
-
* <code>
|
|
615
|
-
*
|
|
616
|
-
* error.</p>
|
|
595
|
+
* <p>You can't specify settings for <code>HealthCheckConfig</code> when the <code>DNSConfig</code> includes
|
|
596
|
+
* <code>CNAME</code> for the value of <code>Type</code>. If you do, the <code>CreateService</code> request
|
|
597
|
+
* will fail with an <code>InvalidInput</code> error.</p>
|
|
617
598
|
* </dd>
|
|
618
599
|
* <dt>Request interval</dt>
|
|
619
600
|
* <dd>
|
|
620
|
-
* <p>A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
* seconds with no health checks at all.</p>
|
|
601
|
+
* <p>A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint
|
|
602
|
+
* every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However,
|
|
603
|
+
* health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one
|
|
604
|
+
* second that's followed by a few seconds with no health checks at all.</p>
|
|
625
605
|
* </dd>
|
|
626
606
|
* <dt>Health checking regions</dt>
|
|
627
607
|
* <dd>
|
|
628
|
-
* <p>Health checkers perform checks from all Route 53 health-checking Regions. For a list of the
|
|
629
|
-
*
|
|
608
|
+
* <p>Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current
|
|
609
|
+
* Regions, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions">Regions</a>.</p>
|
|
630
610
|
* </dd>
|
|
631
611
|
* <dt>Alias records</dt>
|
|
632
612
|
* <dd>
|
|
633
|
-
* <p>When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code>
|
|
634
|
-
*
|
|
613
|
+
* <p>When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code> attribute, Cloud Map
|
|
614
|
+
* creates a Route 53 alias record. Note the following:</p>
|
|
635
615
|
* <ul>
|
|
636
616
|
* <li>
|
|
637
|
-
* <p>Route 53 automatically sets <code>EvaluateTargetHealth</code> to true for alias records.
|
|
638
|
-
*
|
|
639
|
-
*
|
|
617
|
+
* <p>Route 53 automatically sets <code>EvaluateTargetHealth</code> to true for alias records. When
|
|
618
|
+
* <code>EvaluateTargetHealth</code> is true, the alias record inherits the health of the referenced Amazon Web Services
|
|
619
|
+
* resource. such as an ELB load balancer. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth">EvaluateTargetHealth</a>.</p>
|
|
640
620
|
* </li>
|
|
641
621
|
* <li>
|
|
642
|
-
* <p>If you include <code>HealthCheckConfig</code> and then use the service to register an
|
|
643
|
-
*
|
|
622
|
+
* <p>If you include <code>HealthCheckConfig</code> and then use the service to register an instance that
|
|
623
|
+
* creates an alias record, Route 53 doesn't create the health check.</p>
|
|
644
624
|
* </li>
|
|
645
625
|
* </ul>
|
|
646
626
|
* </dd>
|
|
647
627
|
* <dt>Charges for health checks</dt>
|
|
648
628
|
* <dd>
|
|
649
|
-
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For
|
|
650
|
-
*
|
|
629
|
+
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about
|
|
630
|
+
* pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53
|
|
631
|
+
* Pricing</a>.</p>
|
|
651
632
|
* </dd>
|
|
652
633
|
* </dl>
|
|
653
634
|
* @public
|
|
654
635
|
*/
|
|
655
636
|
export interface HealthCheckConfig {
|
|
656
637
|
/**
|
|
657
|
-
* <p>The type of health check that you want to create, which indicates how Route 53 determines
|
|
658
|
-
*
|
|
638
|
+
* <p>The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint
|
|
639
|
+
* is healthy.</p>
|
|
659
640
|
* <important>
|
|
660
641
|
* <p>You can't change the value of <code>Type</code> after you create a health check.</p>
|
|
661
642
|
* </important>
|
|
@@ -663,18 +644,16 @@ export interface HealthCheckConfig {
|
|
|
663
644
|
* <ul>
|
|
664
645
|
* <li>
|
|
665
646
|
* <p>
|
|
666
|
-
* <b>HTTP</b>: Route 53 tries to establish a TCP connection. If
|
|
667
|
-
*
|
|
668
|
-
* and less than 400.</p>
|
|
647
|
+
* <b>HTTP</b>: Route 53 tries to establish a TCP connection. If successful, Route 53
|
|
648
|
+
* submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.</p>
|
|
669
649
|
* </li>
|
|
670
650
|
* <li>
|
|
671
651
|
* <p>
|
|
672
|
-
* <b>HTTPS</b>: Route 53 tries to establish a TCP connection. If
|
|
673
|
-
*
|
|
674
|
-
* and less than 400.</p>
|
|
652
|
+
* <b>HTTPS</b>: Route 53 tries to establish a TCP connection. If successful, Route 53
|
|
653
|
+
* submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.</p>
|
|
675
654
|
* <important>
|
|
676
|
-
* <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS
|
|
677
|
-
*
|
|
655
|
+
* <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS v1.0 or
|
|
656
|
+
* later.</p>
|
|
678
657
|
* </important>
|
|
679
658
|
* </li>
|
|
680
659
|
* <li>
|
|
@@ -684,57 +663,50 @@ export interface HealthCheckConfig {
|
|
|
684
663
|
* <code>ResourcePath</code>.</p>
|
|
685
664
|
* </li>
|
|
686
665
|
* </ul>
|
|
687
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53
|
|
688
|
-
*
|
|
689
|
-
* <i>Route 53 Developer Guide</i>.</p>
|
|
666
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53 Determines
|
|
667
|
+
* Whether an Endpoint Is Healthy</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
690
668
|
* @public
|
|
691
669
|
*/
|
|
692
670
|
Type: HealthCheckType | undefined;
|
|
693
671
|
/**
|
|
694
|
-
* <p>The path that you want Route 53 to request when performing health checks. The path can be any
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
*
|
|
698
|
-
*
|
|
699
|
-
*
|
|
700
|
-
* specify a value for <code>ResourcePath</code>.</p>
|
|
672
|
+
* <p>The path that you want Route 53 to request when performing health checks. The path can be any value that your
|
|
673
|
+
* endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is
|
|
674
|
+
* <code>/docs/route53-health-check.html</code>. Route 53 automatically adds the DNS name for the service. If you
|
|
675
|
+
* don't specify a value for <code>ResourcePath</code>, the default value is <code>/</code>.</p>
|
|
676
|
+
* <p>If you specify <code>TCP</code> for <code>Type</code>, you must <i>not</i> specify a value
|
|
677
|
+
* for <code>ResourcePath</code>.</p>
|
|
701
678
|
* @public
|
|
702
679
|
*/
|
|
703
680
|
ResourcePath?: string;
|
|
704
681
|
/**
|
|
705
|
-
* <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to
|
|
706
|
-
*
|
|
707
|
-
*
|
|
708
|
-
* Determines Whether an Endpoint Is Healthy</a> in the
|
|
709
|
-
* <i>Route 53 Developer Guide</i>.</p>
|
|
682
|
+
* <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current
|
|
683
|
+
* status of the endpoint from unhealthy to healthy or the other way around. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How
|
|
684
|
+
* Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
710
685
|
* @public
|
|
711
686
|
*/
|
|
712
687
|
FailureThreshold?: number;
|
|
713
688
|
}
|
|
714
689
|
/**
|
|
715
|
-
* <p>A complex type that contains information about an optional custom health check. A custom
|
|
716
|
-
*
|
|
717
|
-
*
|
|
690
|
+
* <p>A complex type that contains information about an optional custom health check. A custom health check,
|
|
691
|
+
* which requires that you use a third-party health checker to evaluate the health of your resources, is useful in
|
|
692
|
+
* the following circumstances:</p>
|
|
718
693
|
* <ul>
|
|
719
694
|
* <li>
|
|
720
|
-
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
721
|
-
*
|
|
722
|
-
*
|
|
723
|
-
* checker must also be in the VPC.)</p>
|
|
695
|
+
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the resource isn't
|
|
696
|
+
* available over the internet. For example, you can use a custom health check when the instance is in an Amazon
|
|
697
|
+
* VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)</p>
|
|
724
698
|
* </li>
|
|
725
699
|
* <li>
|
|
726
|
-
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
727
|
-
* located.</p>
|
|
700
|
+
* <p>You want to use a third-party health checker regardless of where your resources are located.</p>
|
|
728
701
|
* </li>
|
|
729
702
|
* </ul>
|
|
730
703
|
* <important>
|
|
731
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
732
|
-
*
|
|
704
|
+
* <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code>
|
|
705
|
+
* or <code>HealthCheckConfig</code> but not both.</p>
|
|
733
706
|
* </important>
|
|
734
|
-
* <p>To change the status of a custom health check, submit an
|
|
735
|
-
*
|
|
736
|
-
*
|
|
737
|
-
* <code>UpdateInstanceCustomHealthStatus</code> request.</p>
|
|
707
|
+
* <p>To change the status of a custom health check, submit an <code>UpdateInstanceCustomHealthStatus</code>
|
|
708
|
+
* request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in
|
|
709
|
+
* the most recent <code>UpdateInstanceCustomHealthStatus</code> request.</p>
|
|
738
710
|
* <p>Here's how custom health checks work:</p>
|
|
739
711
|
* <ol>
|
|
740
712
|
* <li>
|
|
@@ -744,8 +716,8 @@ export interface HealthCheckConfig {
|
|
|
744
716
|
* <p>You register an instance.</p>
|
|
745
717
|
* </li>
|
|
746
718
|
* <li>
|
|
747
|
-
* <p>You configure a third-party health checker to monitor the resource that's associated with
|
|
748
|
-
*
|
|
719
|
+
* <p>You configure a third-party health checker to monitor the resource that's associated with the new
|
|
720
|
+
* instance. </p>
|
|
749
721
|
* <note>
|
|
750
722
|
* <p>Cloud Map doesn't check the health of the resource directly. </p>
|
|
751
723
|
* </note>
|
|
@@ -761,9 +733,8 @@ export interface HealthCheckConfig {
|
|
|
761
733
|
* <p>Cloud Map waits for 30 seconds.</p>
|
|
762
734
|
* </li>
|
|
763
735
|
* <li>
|
|
764
|
-
* <p>If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during
|
|
765
|
-
*
|
|
766
|
-
* resource.</p>
|
|
736
|
+
* <p>If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during that time to
|
|
737
|
+
* change the status back to healthy, Cloud Map stops routing traffic to the resource.</p>
|
|
767
738
|
* </li>
|
|
768
739
|
* </ol>
|
|
769
740
|
* @public
|
|
@@ -773,16 +744,16 @@ export interface HealthCheckCustomConfig {
|
|
|
773
744
|
* @deprecated
|
|
774
745
|
*
|
|
775
746
|
* <important>
|
|
776
|
-
* <p>This parameter is no longer supported and is always set to 1. Cloud Map waits for
|
|
777
|
-
*
|
|
778
|
-
*
|
|
747
|
+
* <p>This parameter is no longer supported and is always set to 1. Cloud Map waits for approximately 30 seconds
|
|
748
|
+
* after receiving an <code>UpdateInstanceCustomHealthStatus</code> request before changing the status of the
|
|
749
|
+
* service instance.</p>
|
|
779
750
|
* </important>
|
|
780
751
|
* <p>The number of 30-second intervals that you want Cloud Map to wait after receiving an
|
|
781
|
-
* <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a
|
|
782
|
-
*
|
|
783
|
-
* <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with
|
|
784
|
-
*
|
|
785
|
-
*
|
|
752
|
+
* <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a service
|
|
753
|
+
* instance.</p>
|
|
754
|
+
* <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with the same value
|
|
755
|
+
* before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits <code>30</code> seconds after the
|
|
756
|
+
* first request to make the change.</p>
|
|
786
757
|
* @public
|
|
787
758
|
*/
|
|
788
759
|
FailureThreshold?: number;
|
|
@@ -805,12 +776,11 @@ export interface CreateServiceRequest {
|
|
|
805
776
|
/**
|
|
806
777
|
* <p>The name that you want to assign to the service.</p>
|
|
807
778
|
* <note>
|
|
808
|
-
* <p>Do not include sensitive information in the name if the namespace is discoverable by public
|
|
809
|
-
*
|
|
779
|
+
* <p>Do not include sensitive information in the name if the namespace is discoverable by public DNS
|
|
780
|
+
* queries.</p>
|
|
810
781
|
* </note>
|
|
811
|
-
* <p>If you want Cloud Map to create an <code>SRV</code> record when you register an instance
|
|
812
|
-
*
|
|
813
|
-
* <code>Name</code>:</p>
|
|
782
|
+
* <p>If you want Cloud Map to create an <code>SRV</code> record when you register an instance and you're using
|
|
783
|
+
* a system that requires a specific <code>SRV</code> format, such as <a href="http://www.haproxy.org/">HAProxy</a>, specify the following for <code>Name</code>:</p>
|
|
814
784
|
* <ul>
|
|
815
785
|
* <li>
|
|
816
786
|
* <p>Start the name with an underscore (_), such as <code>_exampleservice</code>.</p>
|
|
@@ -819,30 +789,29 @@ export interface CreateServiceRequest {
|
|
|
819
789
|
* <p>End the name with <i>._protocol</i>, such as <code>._tcp</code>.</p>
|
|
820
790
|
* </li>
|
|
821
791
|
* </ul>
|
|
822
|
-
* <p>When you register an instance, Cloud Map creates an <code>SRV</code> record and assigns a
|
|
823
|
-
*
|
|
792
|
+
* <p>When you register an instance, Cloud Map creates an <code>SRV</code> record and assigns a name to the
|
|
793
|
+
* record by concatenating the service name and the namespace name (for example,</p>
|
|
824
794
|
* <p>
|
|
825
795
|
* <code>_exampleservice._tcp.example.com</code>).</p>
|
|
826
796
|
* <note>
|
|
827
|
-
* <p>For services that are accessible by DNS queries, you can't create multiple services with
|
|
828
|
-
*
|
|
829
|
-
*
|
|
830
|
-
*
|
|
797
|
+
* <p>For services that are accessible by DNS queries, you can't create multiple services with names that differ
|
|
798
|
+
* only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be
|
|
799
|
+
* distinguished. However, if you use a namespace that's only accessible by API calls, then you can create
|
|
800
|
+
* services that with names that differ only by case.</p>
|
|
831
801
|
* </note>
|
|
832
802
|
* @public
|
|
833
803
|
*/
|
|
834
804
|
Name: string | undefined;
|
|
835
805
|
/**
|
|
836
|
-
* <p>The ID of the namespace that you want to use to create the service. The namespace ID must be
|
|
837
|
-
*
|
|
806
|
+
* <p>The ID of the namespace that you want to use to create the service. The namespace ID must be specified, but
|
|
807
|
+
* it can be specified either here or in the <code>DnsConfig</code> object.</p>
|
|
838
808
|
* @public
|
|
839
809
|
*/
|
|
840
810
|
NamespaceId?: string;
|
|
841
811
|
/**
|
|
842
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
843
|
-
*
|
|
844
|
-
*
|
|
845
|
-
* date/timestamp).</p>
|
|
812
|
+
* <p>A unique string that identifies the request and that allows failed <code>CreateService</code> requests to
|
|
813
|
+
* be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique
|
|
814
|
+
* string (for example, a date/timestamp).</p>
|
|
846
815
|
* @public
|
|
847
816
|
*/
|
|
848
817
|
CreatorRequestId?: string;
|
|
@@ -852,20 +821,19 @@ export interface CreateServiceRequest {
|
|
|
852
821
|
*/
|
|
853
822
|
Description?: string;
|
|
854
823
|
/**
|
|
855
|
-
* <p>A complex type that contains information about the Amazon Route 53 records that you want
|
|
856
|
-
*
|
|
824
|
+
* <p>A complex type that contains information about the Amazon Route 53 records that you want Cloud Map to create
|
|
825
|
+
* when you register an instance. </p>
|
|
857
826
|
* @public
|
|
858
827
|
*/
|
|
859
828
|
DnsConfig?: DnsConfig;
|
|
860
829
|
/**
|
|
861
830
|
* <p>
|
|
862
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
863
|
-
*
|
|
864
|
-
*
|
|
865
|
-
* <code>DnsConfig</code>.</p>
|
|
831
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains settings for an
|
|
832
|
+
* optional Route 53 health check. If you specify settings for a health check, Cloud Map associates the health check
|
|
833
|
+
* with all the Route 53 DNS records that you specify in <code>DnsConfig</code>.</p>
|
|
866
834
|
* <important>
|
|
867
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
868
|
-
*
|
|
835
|
+
* <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code>
|
|
836
|
+
* or <code>HealthCheckConfig</code> but not both.</p>
|
|
869
837
|
* </important>
|
|
870
838
|
* <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/cloud-map/pricing/">Cloud Map Pricing</a>.</p>
|
|
871
839
|
* @public
|
|
@@ -874,25 +842,25 @@ export interface CreateServiceRequest {
|
|
|
874
842
|
/**
|
|
875
843
|
* <p>A complex type that contains information about an optional custom health check.</p>
|
|
876
844
|
* <important>
|
|
877
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
878
|
-
*
|
|
845
|
+
* <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code>
|
|
846
|
+
* or <code>HealthCheckConfig</code> but not both.</p>
|
|
879
847
|
* </important>
|
|
880
|
-
* <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration from
|
|
881
|
-
*
|
|
848
|
+
* <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration from an existing
|
|
849
|
+
* service.</p>
|
|
882
850
|
* @public
|
|
883
851
|
*/
|
|
884
852
|
HealthCheckCustomConfig?: HealthCheckCustomConfig;
|
|
885
853
|
/**
|
|
886
|
-
* <p>The tags to add to the service. Each tag consists of a key and an optional value that you
|
|
887
|
-
*
|
|
854
|
+
* <p>The tags to add to the service. Each tag consists of a key and an optional value that you define.
|
|
855
|
+
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
888
856
|
* characters in length.</p>
|
|
889
857
|
* @public
|
|
890
858
|
*/
|
|
891
859
|
Tags?: Tag[];
|
|
892
860
|
/**
|
|
893
861
|
* <p>If present, specifies that the service instances are only discoverable using the
|
|
894
|
-
* <code>DiscoverInstances</code> API operation. No DNS records is registered for the service
|
|
895
|
-
*
|
|
862
|
+
* <code>DiscoverInstances</code> API operation. No DNS records is registered for the service instances. The only
|
|
863
|
+
* valid value is <code>HTTP</code>.</p>
|
|
896
864
|
* @public
|
|
897
865
|
*/
|
|
898
866
|
Type?: ServiceTypeOption;
|
|
@@ -941,18 +909,18 @@ export interface Service {
|
|
|
941
909
|
*/
|
|
942
910
|
Description?: string;
|
|
943
911
|
/**
|
|
944
|
-
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
945
|
-
*
|
|
946
|
-
*
|
|
912
|
+
* <p>The number of instances that are currently associated with the service. Instances that were previously
|
|
913
|
+
* associated with the service but that are deleted aren't included in the count. The count might not reflect
|
|
914
|
+
* pending registrations and deregistrations.</p>
|
|
947
915
|
* @public
|
|
948
916
|
*/
|
|
949
917
|
InstanceCount?: number;
|
|
950
918
|
/**
|
|
951
|
-
* <p>A complex type that contains information about the Route 53 DNS records that you want
|
|
952
|
-
*
|
|
919
|
+
* <p>A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create
|
|
920
|
+
* when you register an instance.</p>
|
|
953
921
|
* <important>
|
|
954
|
-
* <p>The record types of a service can only be changed by deleting the service and recreating it
|
|
955
|
-
*
|
|
922
|
+
* <p>The record types of a service can only be changed by deleting the service and recreating it with a new
|
|
923
|
+
* <code>Dnsconfig</code>.</p>
|
|
956
924
|
* </important>
|
|
957
925
|
* @public
|
|
958
926
|
*/
|
|
@@ -962,8 +930,8 @@ export interface Service {
|
|
|
962
930
|
* <dl>
|
|
963
931
|
* <dt>DNS_HTTP</dt>
|
|
964
932
|
* <dd>
|
|
965
|
-
* <p>The service instances can be discovered using either DNS queries or the
|
|
966
|
-
*
|
|
933
|
+
* <p>The service instances can be discovered using either DNS queries or the <code>DiscoverInstances</code>
|
|
934
|
+
* API operation.</p>
|
|
967
935
|
* </dd>
|
|
968
936
|
* <dt>HTTP</dt>
|
|
969
937
|
* <dd>
|
|
@@ -980,9 +948,9 @@ export interface Service {
|
|
|
980
948
|
Type?: ServiceType;
|
|
981
949
|
/**
|
|
982
950
|
* <p>
|
|
983
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
984
|
-
*
|
|
985
|
-
*
|
|
951
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains settings for an
|
|
952
|
+
* optional health check. If you specify settings for a health check, Cloud Map associates the health check with
|
|
953
|
+
* the records that you specify in <code>DnsConfig</code>.</p>
|
|
986
954
|
* <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
|
|
987
955
|
* @public
|
|
988
956
|
*/
|
|
@@ -990,23 +958,23 @@ export interface Service {
|
|
|
990
958
|
/**
|
|
991
959
|
* <p>A complex type that contains information about an optional custom health check.</p>
|
|
992
960
|
* <important>
|
|
993
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
994
|
-
*
|
|
961
|
+
* <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code>
|
|
962
|
+
* or <code>HealthCheckConfig</code> but not both.</p>
|
|
995
963
|
* </important>
|
|
996
964
|
* @public
|
|
997
965
|
*/
|
|
998
966
|
HealthCheckCustomConfig?: HealthCheckCustomConfig;
|
|
999
967
|
/**
|
|
1000
|
-
* <p>The date and time that the service was created, in Unix format and Coordinated Universal
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
968
|
+
* <p>The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The
|
|
969
|
+
* value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code>
|
|
970
|
+
* represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1003
971
|
* @public
|
|
1004
972
|
*/
|
|
1005
973
|
CreateDate?: Date;
|
|
1006
974
|
/**
|
|
1007
|
-
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
1008
|
-
*
|
|
1009
|
-
*
|
|
975
|
+
* <p>A unique string that identifies the request and that allows failed requests to be retried without the risk
|
|
976
|
+
* of running the operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
977
|
+
* date/timestamp).</p>
|
|
1010
978
|
* @public
|
|
1011
979
|
*/
|
|
1012
980
|
CreatorRequestId?: string;
|
|
@@ -1058,8 +1026,8 @@ export declare class ServiceAlreadyExists extends __BaseException {
|
|
|
1058
1026
|
constructor(opts: __ExceptionOptionType<ServiceAlreadyExists, __BaseException>);
|
|
1059
1027
|
}
|
|
1060
1028
|
/**
|
|
1061
|
-
* <p>The health check for the instance that's specified by <code>ServiceId</code> and
|
|
1062
|
-
*
|
|
1029
|
+
* <p>The health check for the instance that's specified by <code>ServiceId</code> and <code>InstanceId</code>
|
|
1030
|
+
* isn't a custom health check. </p>
|
|
1063
1031
|
* @public
|
|
1064
1032
|
*/
|
|
1065
1033
|
export declare class CustomHealthNotFound extends __BaseException {
|
|
@@ -1105,8 +1073,8 @@ export interface DeleteNamespaceResponse {
|
|
|
1105
1073
|
OperationId?: string;
|
|
1106
1074
|
}
|
|
1107
1075
|
/**
|
|
1108
|
-
* <p>The specified resource can't be deleted because it contains other resources. For example,
|
|
1109
|
-
*
|
|
1076
|
+
* <p>The specified resource can't be deleted because it contains other resources. For example, you can't delete
|
|
1077
|
+
* a service that contains any instances.</p>
|
|
1110
1078
|
* @public
|
|
1111
1079
|
*/
|
|
1112
1080
|
export declare class ResourceInUse extends __BaseException {
|
|
@@ -1173,8 +1141,8 @@ export interface DeregisterInstanceResponse {
|
|
|
1173
1141
|
OperationId?: string;
|
|
1174
1142
|
}
|
|
1175
1143
|
/**
|
|
1176
|
-
* <p>No instance exists with the specified ID, or the instance was recently registered, and
|
|
1177
|
-
*
|
|
1144
|
+
* <p>No instance exists with the specified ID, or the instance was recently registered, and information about
|
|
1145
|
+
* the instance hasn't propagated yet.</p>
|
|
1178
1146
|
* @public
|
|
1179
1147
|
*/
|
|
1180
1148
|
export declare class InstanceNotFound extends __BaseException {
|
|
@@ -1205,9 +1173,10 @@ export type HealthStatusFilter = (typeof HealthStatusFilter)[keyof typeof Health
|
|
|
1205
1173
|
*/
|
|
1206
1174
|
export interface DiscoverInstancesRequest {
|
|
1207
1175
|
/**
|
|
1208
|
-
* <p>The <code>HttpName</code> name of the namespace. It's found in the
|
|
1209
|
-
*
|
|
1210
|
-
* namespace
|
|
1176
|
+
* <p>The <code>HttpName</code> name of the namespace. It's found in the <code>HttpProperties</code> member of
|
|
1177
|
+
* the <code>Properties</code> member of the namespace. In most cases, <code>Name</code> and <code>HttpName</code>
|
|
1178
|
+
* match. However, if you reuse <code>Name</code> for namespace creation, a generated hash is added to
|
|
1179
|
+
* <code>HttpName</code> to distinguish the two.</p>
|
|
1211
1180
|
* @public
|
|
1212
1181
|
*/
|
|
1213
1182
|
NamespaceName: string | undefined;
|
|
@@ -1218,30 +1187,28 @@ export interface DiscoverInstancesRequest {
|
|
|
1218
1187
|
ServiceName: string | undefined;
|
|
1219
1188
|
/**
|
|
1220
1189
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
1221
|
-
* <code>DiscoverInstances</code> request. If you don't specify a value for
|
|
1222
|
-
*
|
|
1190
|
+
* <code>DiscoverInstances</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map
|
|
1191
|
+
* returns up to 100 instances.</p>
|
|
1223
1192
|
* @public
|
|
1224
1193
|
*/
|
|
1225
1194
|
MaxResults?: number;
|
|
1226
1195
|
/**
|
|
1227
|
-
* <p>Filters to scope the results based on custom attributes for the instance (for example,
|
|
1228
|
-
*
|
|
1229
|
-
* are returned.</p>
|
|
1196
|
+
* <p>Filters to scope the results based on custom attributes for the instance (for example, <code>\{version=v1,
|
|
1197
|
+
* az=1a\}</code>). Only instances that match all the specified key-value pairs are returned.</p>
|
|
1230
1198
|
* @public
|
|
1231
1199
|
*/
|
|
1232
1200
|
QueryParameters?: Record<string, string>;
|
|
1233
1201
|
/**
|
|
1234
|
-
* <p>Opportunistic filters to scope the results based on custom attributes. If there are
|
|
1235
|
-
*
|
|
1236
|
-
*
|
|
1237
|
-
*
|
|
1238
|
-
* <code>QueryParameters</code> parameter are returned.</p>
|
|
1202
|
+
* <p>Opportunistic filters to scope the results based on custom attributes. If there are instances that match
|
|
1203
|
+
* both the filters specified in both the <code>QueryParameters</code> parameter and this parameter, all of these
|
|
1204
|
+
* instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are
|
|
1205
|
+
* specified in the <code>QueryParameters</code> parameter are returned.</p>
|
|
1239
1206
|
* @public
|
|
1240
1207
|
*/
|
|
1241
1208
|
OptionalParameters?: Record<string, string>;
|
|
1242
1209
|
/**
|
|
1243
|
-
* <p>The health status of the instances that you want to discover. This parameter is ignored for
|
|
1244
|
-
*
|
|
1210
|
+
* <p>The health status of the instances that you want to discover. This parameter is ignored for services that
|
|
1211
|
+
* don't have a health check configured, and
|
|
1245
1212
|
* all
|
|
1246
1213
|
* instances are returned.</p>
|
|
1247
1214
|
* <dl>
|
|
@@ -1259,8 +1226,8 @@ export interface DiscoverInstancesRequest {
|
|
|
1259
1226
|
* </dd>
|
|
1260
1227
|
* <dt>HEALTHY_OR_ELSE_ALL</dt>
|
|
1261
1228
|
* <dd>
|
|
1262
|
-
* <p>Returns healthy instances, unless none are reporting a healthy state. In that case,
|
|
1263
|
-
*
|
|
1229
|
+
* <p>Returns healthy instances, unless none are reporting a healthy state. In that case, return all
|
|
1230
|
+
* instances. This is also called failing open.</p>
|
|
1264
1231
|
* </dd>
|
|
1265
1232
|
* </dl>
|
|
1266
1233
|
* @public
|
|
@@ -1281,9 +1248,8 @@ export declare const HealthStatus: {
|
|
|
1281
1248
|
*/
|
|
1282
1249
|
export type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];
|
|
1283
1250
|
/**
|
|
1284
|
-
* <p>In a response to a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a> request,
|
|
1285
|
-
*
|
|
1286
|
-
* that you specified in the request.</p>
|
|
1251
|
+
* <p>In a response to a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a> request, <code>HttpInstanceSummary</code> contains information about one instance
|
|
1252
|
+
* that matches the values that you specified in the request.</p>
|
|
1287
1253
|
* @public
|
|
1288
1254
|
*/
|
|
1289
1255
|
export interface HttpInstanceSummary {
|
|
@@ -1298,9 +1264,8 @@ export interface HttpInstanceSummary {
|
|
|
1298
1264
|
* <code></code>
|
|
1299
1265
|
* <code></code>
|
|
1300
1266
|
* </p>
|
|
1301
|
-
* <p>The <code>HttpName</code> name of the namespace. It's found in the
|
|
1302
|
-
*
|
|
1303
|
-
* namespace.</p>
|
|
1267
|
+
* <p>The <code>HttpName</code> name of the namespace. It's found in the <code>HttpProperties</code> member of
|
|
1268
|
+
* the <code>Properties</code> member of the namespace.</p>
|
|
1304
1269
|
* @public
|
|
1305
1270
|
*/
|
|
1306
1271
|
NamespaceName?: string;
|
|
@@ -1310,14 +1275,12 @@ export interface HttpInstanceSummary {
|
|
|
1310
1275
|
*/
|
|
1311
1276
|
ServiceName?: string;
|
|
1312
1277
|
/**
|
|
1313
|
-
* <p>If you configured health checking in the service, the current health status of the service
|
|
1314
|
-
* instance.</p>
|
|
1278
|
+
* <p>If you configured health checking in the service, the current health status of the service instance.</p>
|
|
1315
1279
|
* @public
|
|
1316
1280
|
*/
|
|
1317
1281
|
HealthStatus?: HealthStatus;
|
|
1318
1282
|
/**
|
|
1319
|
-
* <p>If you included any attributes when you registered the instance, the values of those
|
|
1320
|
-
* attributes.</p>
|
|
1283
|
+
* <p>If you included any attributes when you registered the instance, the values of those attributes.</p>
|
|
1321
1284
|
* @public
|
|
1322
1285
|
*/
|
|
1323
1286
|
Attributes?: Record<string, string>;
|
|
@@ -1327,23 +1290,22 @@ export interface HttpInstanceSummary {
|
|
|
1327
1290
|
*/
|
|
1328
1291
|
export interface DiscoverInstancesResponse {
|
|
1329
1292
|
/**
|
|
1330
|
-
* <p>A complex type that contains one <code>HttpInstanceSummary</code> for each registered
|
|
1331
|
-
* instance.</p>
|
|
1293
|
+
* <p>A complex type that contains one <code>HttpInstanceSummary</code> for each registered instance.</p>
|
|
1332
1294
|
* @public
|
|
1333
1295
|
*/
|
|
1334
1296
|
Instances?: HttpInstanceSummary[];
|
|
1335
1297
|
/**
|
|
1336
|
-
* <p>The increasing revision associated to the response Instances list. If a new instance is
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1298
|
+
* <p>The increasing revision associated to the response Instances list. If a new instance is registered or
|
|
1299
|
+
* deregistered, the <code>InstancesRevision</code> updates. The health status updates don't update
|
|
1300
|
+
* <code>InstancesRevision</code>.</p>
|
|
1339
1301
|
* @public
|
|
1340
1302
|
*/
|
|
1341
1303
|
InstancesRevision?: number;
|
|
1342
1304
|
}
|
|
1343
1305
|
/**
|
|
1344
|
-
* <p>The operation can't be completed because you've reached the quota for the number of
|
|
1345
|
-
*
|
|
1346
|
-
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1306
|
+
* <p>The operation can't be completed because you've reached the quota for the number of requests. For more
|
|
1307
|
+
* information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request
|
|
1308
|
+
* throttling quota</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
1347
1309
|
* @public
|
|
1348
1310
|
*/
|
|
1349
1311
|
export declare class RequestLimitExceeded extends __BaseException {
|
|
@@ -1360,9 +1322,8 @@ export declare class RequestLimitExceeded extends __BaseException {
|
|
|
1360
1322
|
*/
|
|
1361
1323
|
export interface DiscoverInstancesRevisionRequest {
|
|
1362
1324
|
/**
|
|
1363
|
-
* <p>The <code>HttpName</code> name of the namespace. It's found in the
|
|
1364
|
-
*
|
|
1365
|
-
* namespace.</p>
|
|
1325
|
+
* <p>The <code>HttpName</code> name of the namespace. It's found in the <code>HttpProperties</code> member of
|
|
1326
|
+
* the <code>Properties</code> member of the namespace.</p>
|
|
1366
1327
|
* @public
|
|
1367
1328
|
*/
|
|
1368
1329
|
NamespaceName: string | undefined;
|
|
@@ -1377,29 +1338,29 @@ export interface DiscoverInstancesRevisionRequest {
|
|
|
1377
1338
|
*/
|
|
1378
1339
|
export interface DiscoverInstancesRevisionResponse {
|
|
1379
1340
|
/**
|
|
1380
|
-
* <p>The increasing revision associated to the response Instances list. If a new instance is
|
|
1381
|
-
*
|
|
1382
|
-
*
|
|
1341
|
+
* <p>The increasing revision associated to the response Instances list. If a new instance is registered or
|
|
1342
|
+
* deregistered, the <code>InstancesRevision</code> updates. The health status updates don't update
|
|
1343
|
+
* <code>InstancesRevision</code>.</p>
|
|
1383
1344
|
* @public
|
|
1384
1345
|
*/
|
|
1385
1346
|
InstancesRevision?: number;
|
|
1386
1347
|
}
|
|
1387
1348
|
/**
|
|
1388
|
-
* <p>A complex type that contains information about changes to the Route 53 DNS records that
|
|
1389
|
-
*
|
|
1349
|
+
* <p>A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates
|
|
1350
|
+
* when you register an instance.</p>
|
|
1390
1351
|
* @public
|
|
1391
1352
|
*/
|
|
1392
1353
|
export interface DnsConfigChange {
|
|
1393
1354
|
/**
|
|
1394
|
-
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 record that you want
|
|
1395
|
-
*
|
|
1355
|
+
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 record that you want Cloud Map to
|
|
1356
|
+
* create when you register an instance.</p>
|
|
1396
1357
|
* @public
|
|
1397
1358
|
*/
|
|
1398
1359
|
DnsRecords: DnsRecord[] | undefined;
|
|
1399
1360
|
}
|
|
1400
1361
|
/**
|
|
1401
|
-
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
|
|
1402
|
-
*
|
|
1362
|
+
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a
|
|
1363
|
+
* namespace.</p>
|
|
1403
1364
|
* @public
|
|
1404
1365
|
*/
|
|
1405
1366
|
export interface DnsProperties {
|
|
@@ -1444,8 +1405,8 @@ export interface GetInstanceRequest {
|
|
|
1444
1405
|
InstanceId: string | undefined;
|
|
1445
1406
|
}
|
|
1446
1407
|
/**
|
|
1447
|
-
* <p>A complex type that contains information about an instance that Cloud Map creates when you
|
|
1448
|
-
*
|
|
1408
|
+
* <p>A complex type that contains information about an instance that Cloud Map creates when you submit a
|
|
1409
|
+
* <code>RegisterInstance</code> request.</p>
|
|
1449
1410
|
* @public
|
|
1450
1411
|
*/
|
|
1451
1412
|
export interface Instance {
|
|
@@ -1453,25 +1414,24 @@ export interface Instance {
|
|
|
1453
1414
|
* <p>An identifier that you want to associate with the instance. Note the following:</p>
|
|
1454
1415
|
* <ul>
|
|
1455
1416
|
* <li>
|
|
1456
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
1457
|
-
*
|
|
1458
|
-
*
|
|
1459
|
-
* Type</a>.</p>
|
|
1417
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an <code>SRV</code>
|
|
1418
|
+
* record, the value of <code>InstanceId</code> is automatically included as part of the value for the
|
|
1419
|
+
* <code>SRV</code> record. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type">DnsRecord > Type</a>.</p>
|
|
1460
1420
|
* </li>
|
|
1461
1421
|
* <li>
|
|
1462
1422
|
* <p>You can use this value to update an existing instance.</p>
|
|
1463
1423
|
* </li>
|
|
1464
1424
|
* <li>
|
|
1465
|
-
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
1466
|
-
*
|
|
1425
|
+
* <p>To register a new instance, you must specify a value that's unique among instances that you register by
|
|
1426
|
+
* using the same service. </p>
|
|
1467
1427
|
* </li>
|
|
1468
1428
|
* <li>
|
|
1469
|
-
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
1470
|
-
*
|
|
1471
|
-
*
|
|
1429
|
+
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map updates the
|
|
1430
|
+
* existing DNS records. If there's also an existing health check, Cloud Map deletes the old health check and
|
|
1431
|
+
* creates a new one. </p>
|
|
1472
1432
|
* <note>
|
|
1473
|
-
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
1474
|
-
*
|
|
1433
|
+
* <p>The health check isn't deleted immediately, so it will still appear for a while if you submit a
|
|
1434
|
+
* <code>ListHealthChecks</code> request, for example.</p>
|
|
1475
1435
|
* </note>
|
|
1476
1436
|
* </li>
|
|
1477
1437
|
* </ul>
|
|
@@ -1479,12 +1439,11 @@ export interface Instance {
|
|
|
1479
1439
|
*/
|
|
1480
1440
|
Id: string | undefined;
|
|
1481
1441
|
/**
|
|
1482
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1485
|
-
*
|
|
1486
|
-
*
|
|
1487
|
-
* date/time stamp).</p>
|
|
1442
|
+
* <p>A unique string that identifies the request and that allows failed <code>RegisterInstance</code> requests
|
|
1443
|
+
* to be retried without the risk of executing the operation twice. You must use a unique
|
|
1444
|
+
* <code>CreatorRequestId</code> string every time you submit a <code>RegisterInstance</code> request if you're
|
|
1445
|
+
* registering additional instances for the same namespace and service. <code>CreatorRequestId</code> can be any
|
|
1446
|
+
* unique string (for example, a date/time stamp).</p>
|
|
1488
1447
|
* @public
|
|
1489
1448
|
*/
|
|
1490
1449
|
CreatorRequestId?: string;
|
|
@@ -1500,38 +1459,38 @@ export interface Instance {
|
|
|
1500
1459
|
* </li>
|
|
1501
1460
|
* </ul>
|
|
1502
1461
|
* <note>
|
|
1503
|
-
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by
|
|
1504
|
-
*
|
|
1462
|
+
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by public DNS
|
|
1463
|
+
* queries.</p>
|
|
1505
1464
|
* </note>
|
|
1506
1465
|
* <p>Supported attribute keys include the following:</p>
|
|
1507
1466
|
* <dl>
|
|
1508
1467
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
1509
1468
|
* <dd>
|
|
1510
|
-
* <p>If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing
|
|
1511
|
-
*
|
|
1512
|
-
*
|
|
1469
|
+
* <p>If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer,
|
|
1470
|
+
* specify the DNS name that's associated with the load balancer. For information about how to get the DNS name,
|
|
1471
|
+
* see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-DNSName">AliasTarget->DNSName</a> in the <i>Route 53 API Reference</i>.</p>
|
|
1513
1472
|
* <p>Note the following:</p>
|
|
1514
1473
|
* <ul>
|
|
1515
1474
|
* <li>
|
|
1516
|
-
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
1517
|
-
*
|
|
1475
|
+
* <p>The configuration for the service that's specified by <code>ServiceId</code> must include settings for
|
|
1476
|
+
* an <code>A</code> record, an <code>AAAA</code> record, or both.</p>
|
|
1518
1477
|
* </li>
|
|
1519
1478
|
* <li>
|
|
1520
|
-
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
1521
|
-
*
|
|
1479
|
+
* <p>In the service that's specified by <code>ServiceId</code>, the value of <code>RoutingPolicy</code>
|
|
1480
|
+
* must be <code>WEIGHTED</code>.</p>
|
|
1522
1481
|
* </li>
|
|
1523
1482
|
* <li>
|
|
1524
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
1525
|
-
*
|
|
1526
|
-
*
|
|
1483
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes <code>HealthCheckConfig</code>
|
|
1484
|
+
* settings, Cloud Map creates the health check, but it won't associate the health check with the alias
|
|
1485
|
+
* record.</p>
|
|
1527
1486
|
* </li>
|
|
1528
1487
|
* <li>
|
|
1529
|
-
* <p>Auto naming currently doesn't support creating alias records that route traffic to
|
|
1530
|
-
*
|
|
1488
|
+
* <p>Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources
|
|
1489
|
+
* other than ELB load balancers.</p>
|
|
1531
1490
|
* </li>
|
|
1532
1491
|
* <li>
|
|
1533
|
-
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
1534
|
-
*
|
|
1492
|
+
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for any of the
|
|
1493
|
+
* <code>AWS_INSTANCE</code> attributes.</p>
|
|
1535
1494
|
* </li>
|
|
1536
1495
|
* </ul>
|
|
1537
1496
|
* </dd>
|
|
@@ -1543,46 +1502,43 @@ export interface Instance {
|
|
|
1543
1502
|
* </dd>
|
|
1544
1503
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
1545
1504
|
* <dd>
|
|
1546
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
1547
|
-
*
|
|
1548
|
-
*
|
|
1505
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can optionally use
|
|
1506
|
+
* <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom health check,
|
|
1507
|
+
* <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
1549
1508
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
1550
1509
|
* </dd>
|
|
1551
1510
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
1552
1511
|
* <dd>
|
|
1553
|
-
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
1554
|
-
*
|
|
1555
|
-
*
|
|
1556
|
-
*
|
|
1557
|
-
* settings for an <code>CNAME</code> record.</p>
|
|
1512
|
+
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that you want Route 53
|
|
1513
|
+
* to return in response to DNS queries (for example, <code>example.com</code>).</p>
|
|
1514
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
|
|
1515
|
+
* <code>CNAME</code> record.</p>
|
|
1558
1516
|
* </dd>
|
|
1559
1517
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
1560
1518
|
* <dd>
|
|
1561
|
-
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
1562
|
-
*
|
|
1563
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1564
|
-
*
|
|
1565
|
-
*
|
|
1566
|
-
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
1519
|
+
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you want Route 53 to
|
|
1520
|
+
* return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
1521
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
|
|
1522
|
+
* <code>A</code> record. If the service includes settings for an <code>SRV</code> record, you must specify a
|
|
1523
|
+
* value for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
1567
1524
|
* </dd>
|
|
1568
1525
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
1569
1526
|
* <dd>
|
|
1570
|
-
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
1571
|
-
*
|
|
1572
|
-
*
|
|
1573
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1574
|
-
*
|
|
1575
|
-
*
|
|
1576
|
-
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
1527
|
+
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that you want Route 53
|
|
1528
|
+
* to return in response to DNS queries (for example,
|
|
1529
|
+
* <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
1530
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
|
|
1531
|
+
* <code>AAAA</code> record. If the service includes settings for an <code>SRV</code> record, you must specify
|
|
1532
|
+
* a value for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
1577
1533
|
* </dd>
|
|
1578
1534
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
1579
1535
|
* <dd>
|
|
1580
|
-
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to
|
|
1581
|
-
*
|
|
1582
|
-
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
1583
|
-
*
|
|
1584
|
-
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
1585
|
-
*
|
|
1536
|
+
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to return for the
|
|
1537
|
+
* port.</p>
|
|
1538
|
+
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you want Route 53 to
|
|
1539
|
+
* send requests to. </p>
|
|
1540
|
+
* <p>This value is required if you specified settings for an <code>SRV</code> record or a Route 53 health check
|
|
1541
|
+
* when you created the service.</p>
|
|
1586
1542
|
* </dd>
|
|
1587
1543
|
* </dl>
|
|
1588
1544
|
* @public
|
|
@@ -1609,29 +1565,27 @@ export interface GetInstancesHealthStatusRequest {
|
|
|
1609
1565
|
*/
|
|
1610
1566
|
ServiceId: string | undefined;
|
|
1611
1567
|
/**
|
|
1612
|
-
* <p>An array that contains the IDs of all the instances that you want to get the health status
|
|
1613
|
-
*
|
|
1614
|
-
*
|
|
1615
|
-
* instances that are associated with the specified service.</p>
|
|
1568
|
+
* <p>An array that contains the IDs of all the instances that you want to get the health status for.</p>
|
|
1569
|
+
* <p>If you omit <code>Instances</code>, Cloud Map returns the health status for all the instances that are
|
|
1570
|
+
* associated with the specified service.</p>
|
|
1616
1571
|
* <note>
|
|
1617
|
-
* <p>To get the IDs for the instances that you've registered by using a specified service,
|
|
1618
|
-
* submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html">ListInstances</a> request.</p>
|
|
1572
|
+
* <p>To get the IDs for the instances that you've registered by using a specified service, submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html">ListInstances</a> request.</p>
|
|
1619
1573
|
* </note>
|
|
1620
1574
|
* @public
|
|
1621
1575
|
*/
|
|
1622
1576
|
Instances?: string[];
|
|
1623
1577
|
/**
|
|
1624
1578
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
1625
|
-
* <code>GetInstancesHealthStatus</code> request. If you don't specify a value for
|
|
1626
|
-
*
|
|
1579
|
+
* <code>GetInstancesHealthStatus</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
1580
|
+
* Cloud Map returns up to 100 instances.</p>
|
|
1627
1581
|
* @public
|
|
1628
1582
|
*/
|
|
1629
1583
|
MaxResults?: number;
|
|
1630
1584
|
/**
|
|
1631
1585
|
* <p>For the first <code>GetInstancesHealthStatus</code> request, omit this value.</p>
|
|
1632
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1633
|
-
*
|
|
1634
|
-
*
|
|
1586
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit another
|
|
1587
|
+
* <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify the value of
|
|
1588
|
+
* <code>NextToken</code> from the previous response in the next request.</p>
|
|
1635
1589
|
* @public
|
|
1636
1590
|
*/
|
|
1637
1591
|
NextToken?: string;
|
|
@@ -1641,15 +1595,15 @@ export interface GetInstancesHealthStatusRequest {
|
|
|
1641
1595
|
*/
|
|
1642
1596
|
export interface GetInstancesHealthStatusResponse {
|
|
1643
1597
|
/**
|
|
1644
|
-
* <p>A complex type that contains the IDs and the health status of the instances that you
|
|
1645
|
-
*
|
|
1598
|
+
* <p>A complex type that contains the IDs and the health status of the instances that you specified in the
|
|
1599
|
+
* <code>GetInstancesHealthStatus</code> request.</p>
|
|
1646
1600
|
* @public
|
|
1647
1601
|
*/
|
|
1648
1602
|
Status?: Record<string, HealthStatus>;
|
|
1649
1603
|
/**
|
|
1650
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1651
|
-
*
|
|
1652
|
-
*
|
|
1604
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit another
|
|
1605
|
+
* <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify the value of
|
|
1606
|
+
* <code>NextToken</code> from the previous response in the next request.</p>
|
|
1653
1607
|
* @public
|
|
1654
1608
|
*/
|
|
1655
1609
|
NextToken?: string;
|
|
@@ -1681,8 +1635,8 @@ export interface HttpProperties {
|
|
|
1681
1635
|
*/
|
|
1682
1636
|
export interface NamespaceProperties {
|
|
1683
1637
|
/**
|
|
1684
|
-
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
|
|
1685
|
-
*
|
|
1638
|
+
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a
|
|
1639
|
+
* namespace.</p>
|
|
1686
1640
|
* @public
|
|
1687
1641
|
*/
|
|
1688
1642
|
DnsProperties?: DnsProperties;
|
|
@@ -1726,23 +1680,23 @@ export interface Namespace {
|
|
|
1726
1680
|
*/
|
|
1727
1681
|
Name?: string;
|
|
1728
1682
|
/**
|
|
1729
|
-
* <p>The type of the namespace. The methods for discovering instances depends on the value that
|
|
1730
|
-
*
|
|
1683
|
+
* <p>The type of the namespace. The methods for discovering instances depends on the value that you
|
|
1684
|
+
* specify:</p>
|
|
1731
1685
|
* <dl>
|
|
1732
1686
|
* <dt>HTTP</dt>
|
|
1733
1687
|
* <dd>
|
|
1734
|
-
* <p>Instances can be discovered only programmatically, using the Cloud Map
|
|
1735
|
-
*
|
|
1688
|
+
* <p>Instances can be discovered only programmatically, using the Cloud Map <code>DiscoverInstances</code>
|
|
1689
|
+
* API.</p>
|
|
1736
1690
|
* </dd>
|
|
1737
1691
|
* <dt>DNS_PUBLIC</dt>
|
|
1738
1692
|
* <dd>
|
|
1739
|
-
* <p>Instances can be discovered using public DNS queries and using the
|
|
1740
|
-
*
|
|
1693
|
+
* <p>Instances can be discovered using public DNS queries and using the <code>DiscoverInstances</code>
|
|
1694
|
+
* API.</p>
|
|
1741
1695
|
* </dd>
|
|
1742
1696
|
* <dt>DNS_PRIVATE</dt>
|
|
1743
1697
|
* <dd>
|
|
1744
|
-
* <p>Instances can be discovered using DNS queries in VPCs and using the
|
|
1745
|
-
*
|
|
1698
|
+
* <p>Instances can be discovered using DNS queries in VPCs and using the <code>DiscoverInstances</code>
|
|
1699
|
+
* API.</p>
|
|
1746
1700
|
* </dd>
|
|
1747
1701
|
* </dl>
|
|
1748
1702
|
* @public
|
|
@@ -1759,21 +1713,20 @@ export interface Namespace {
|
|
|
1759
1713
|
*/
|
|
1760
1714
|
ServiceCount?: number;
|
|
1761
1715
|
/**
|
|
1762
|
-
* <p>A complex type that contains information that's specific to the type of the
|
|
1763
|
-
* namespace.</p>
|
|
1716
|
+
* <p>A complex type that contains information that's specific to the type of the namespace.</p>
|
|
1764
1717
|
* @public
|
|
1765
1718
|
*/
|
|
1766
1719
|
Properties?: NamespaceProperties;
|
|
1767
1720
|
/**
|
|
1768
|
-
* <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal
|
|
1769
|
-
*
|
|
1770
|
-
*
|
|
1721
|
+
* <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The
|
|
1722
|
+
* value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code>
|
|
1723
|
+
* represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1771
1724
|
* @public
|
|
1772
1725
|
*/
|
|
1773
1726
|
CreateDate?: Date;
|
|
1774
1727
|
/**
|
|
1775
|
-
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
1776
|
-
*
|
|
1728
|
+
* <p>A unique string that identifies the request and that allows failed requests to be retried without the risk
|
|
1729
|
+
* of running an operation twice. </p>
|
|
1777
1730
|
* @public
|
|
1778
1731
|
*/
|
|
1779
1732
|
CreatorRequestId?: string;
|
|
@@ -1880,14 +1833,13 @@ export interface Operation {
|
|
|
1880
1833
|
*/
|
|
1881
1834
|
Status?: OperationStatus;
|
|
1882
1835
|
/**
|
|
1883
|
-
* <p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation
|
|
1884
|
-
* failed.</p>
|
|
1836
|
+
* <p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation failed.</p>
|
|
1885
1837
|
* @public
|
|
1886
1838
|
*/
|
|
1887
1839
|
ErrorMessage?: string;
|
|
1888
1840
|
/**
|
|
1889
|
-
* <p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code>
|
|
1890
|
-
*
|
|
1841
|
+
* <p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code> include the
|
|
1842
|
+
* following:</p>
|
|
1891
1843
|
* <ul>
|
|
1892
1844
|
* <li>
|
|
1893
1845
|
* <p>
|
|
@@ -1929,18 +1881,16 @@ export interface Operation {
|
|
|
1929
1881
|
*/
|
|
1930
1882
|
ErrorCode?: string;
|
|
1931
1883
|
/**
|
|
1932
|
-
* <p>The date and time that the request was submitted, in Unix date/time format and Coordinated
|
|
1933
|
-
*
|
|
1934
|
-
*
|
|
1935
|
-
* AM.</p>
|
|
1884
|
+
* <p>The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time
|
|
1885
|
+
* (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value
|
|
1886
|
+
* <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1936
1887
|
* @public
|
|
1937
1888
|
*/
|
|
1938
1889
|
CreateDate?: Date;
|
|
1939
1890
|
/**
|
|
1940
|
-
* <p>The date and time that the value of <code>Status</code> changed to the current value, in
|
|
1941
|
-
*
|
|
1942
|
-
*
|
|
1943
|
-
* Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1891
|
+
* <p>The date and time that the value of <code>Status</code> changed to the current value, in Unix date/time
|
|
1892
|
+
* format and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code> is accurate to milliseconds.
|
|
1893
|
+
* For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1944
1894
|
* @public
|
|
1945
1895
|
*/
|
|
1946
1896
|
UpdateDate?: Date;
|
|
@@ -2008,21 +1958,21 @@ export interface GetServiceResponse {
|
|
|
2008
1958
|
Service?: Service;
|
|
2009
1959
|
}
|
|
2010
1960
|
/**
|
|
2011
|
-
* <p>Updated properties
|
|
2012
|
-
*
|
|
1961
|
+
* <p>Updated properties for the HTTP
|
|
1962
|
+
* namespace.</p>
|
|
2013
1963
|
* @public
|
|
2014
1964
|
*/
|
|
2015
1965
|
export interface HttpNamespaceChange {
|
|
2016
1966
|
/**
|
|
2017
|
-
* <p>An updated
|
|
2018
|
-
*
|
|
1967
|
+
* <p>An updated description for the HTTP
|
|
1968
|
+
* namespace.</p>
|
|
2019
1969
|
* @public
|
|
2020
1970
|
*/
|
|
2021
1971
|
Description: string | undefined;
|
|
2022
1972
|
}
|
|
2023
1973
|
/**
|
|
2024
|
-
* <p>A complex type that contains information about the instances that you registered by using a
|
|
2025
|
-
*
|
|
1974
|
+
* <p>A complex type that contains information about the instances that you registered by using a specified
|
|
1975
|
+
* service.</p>
|
|
2026
1976
|
* @public
|
|
2027
1977
|
*/
|
|
2028
1978
|
export interface InstanceSummary {
|
|
@@ -2045,42 +1995,41 @@ export interface InstanceSummary {
|
|
|
2045
1995
|
* <dl>
|
|
2046
1996
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
2047
1997
|
* <dd>
|
|
2048
|
-
* <p>For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
|
|
2049
|
-
*
|
|
1998
|
+
* <p>For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with
|
|
1999
|
+
* the load balancer. </p>
|
|
2050
2000
|
* </dd>
|
|
2051
2001
|
* <dt>AWS_EC2_INSTANCE_ID (HTTP namespaces only)</dt>
|
|
2052
2002
|
* <dd>
|
|
2053
|
-
* <p>The Amazon EC2 instance ID for the instance. When the <code>AWS_EC2_INSTANCE_ID</code>
|
|
2054
|
-
*
|
|
2055
|
-
*
|
|
2003
|
+
* <p>The Amazon EC2 instance ID for the instance. When the <code>AWS_EC2_INSTANCE_ID</code> attribute is
|
|
2004
|
+
* specified, then the <code>AWS_INSTANCE_IPV4</code> attribute contains the primary private IPv4
|
|
2005
|
+
* address.</p>
|
|
2056
2006
|
* </dd>
|
|
2057
2007
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
2058
2008
|
* <dd>
|
|
2059
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
2060
|
-
*
|
|
2061
|
-
*
|
|
2009
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can optionally use
|
|
2010
|
+
* <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom health check,
|
|
2011
|
+
* <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
2062
2012
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
2063
2013
|
* </dd>
|
|
2064
2014
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
2065
2015
|
* <dd>
|
|
2066
|
-
* <p>For a <code>CNAME</code> record, the domain name that Route 53 returns in response to DNS
|
|
2067
|
-
*
|
|
2016
|
+
* <p>For a <code>CNAME</code> record, the domain name that Route 53 returns in response to DNS queries (for
|
|
2017
|
+
* example, <code>example.com</code>).</p>
|
|
2068
2018
|
* </dd>
|
|
2069
2019
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
2070
2020
|
* <dd>
|
|
2071
|
-
* <p>For an <code>A</code> record, the IPv4 address that Route 53 returns in response to DNS
|
|
2072
|
-
*
|
|
2021
|
+
* <p>For an <code>A</code> record, the IPv4 address that Route 53 returns in response to DNS queries (for
|
|
2022
|
+
* example, <code>192.0.2.44</code>).</p>
|
|
2073
2023
|
* </dd>
|
|
2074
2024
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
2075
2025
|
* <dd>
|
|
2076
|
-
* <p>For an <code>AAAA</code> record, the IPv6 address that Route 53 returns in response to DNS
|
|
2077
|
-
*
|
|
2026
|
+
* <p>For an <code>AAAA</code> record, the IPv6 address that Route 53 returns in response to DNS queries (for
|
|
2027
|
+
* example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
2078
2028
|
* </dd>
|
|
2079
2029
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
2080
2030
|
* <dd>
|
|
2081
|
-
* <p>For an <code>SRV</code> record, the value that Route 53 returns for the port. In addition,
|
|
2082
|
-
*
|
|
2083
|
-
* sends requests to.</p>
|
|
2031
|
+
* <p>For an <code>SRV</code> record, the value that Route 53 returns for the port. In addition, if the service
|
|
2032
|
+
* includes <code>HealthCheckConfig</code>, the port on the endpoint that Route 53 sends requests to.</p>
|
|
2084
2033
|
* </dd>
|
|
2085
2034
|
* </dl>
|
|
2086
2035
|
* @public
|
|
@@ -2098,16 +2047,16 @@ export interface ListInstancesRequest {
|
|
|
2098
2047
|
ServiceId: string | undefined;
|
|
2099
2048
|
/**
|
|
2100
2049
|
* <p>For the first <code>ListInstances</code> request, omit this value.</p>
|
|
2101
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
2102
|
-
*
|
|
2050
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit another
|
|
2051
|
+
* <code>ListInstances</code> request to get the next group of results. Specify the value of
|
|
2103
2052
|
* <code>NextToken</code> from the previous response in the next request.</p>
|
|
2104
2053
|
* @public
|
|
2105
2054
|
*/
|
|
2106
2055
|
NextToken?: string;
|
|
2107
2056
|
/**
|
|
2108
2057
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
2109
|
-
* <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2110
|
-
*
|
|
2058
|
+
* <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map
|
|
2059
|
+
* returns up to 100 instances.</p>
|
|
2111
2060
|
* @public
|
|
2112
2061
|
*/
|
|
2113
2062
|
MaxResults?: number;
|
|
@@ -2117,14 +2066,13 @@ export interface ListInstancesRequest {
|
|
|
2117
2066
|
*/
|
|
2118
2067
|
export interface ListInstancesResponse {
|
|
2119
2068
|
/**
|
|
2120
|
-
* <p>Summary information about the instances that are associated with the specified
|
|
2121
|
-
* service.</p>
|
|
2069
|
+
* <p>Summary information about the instances that are associated with the specified service.</p>
|
|
2122
2070
|
* @public
|
|
2123
2071
|
*/
|
|
2124
2072
|
Instances?: InstanceSummary[];
|
|
2125
2073
|
/**
|
|
2126
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
2127
|
-
*
|
|
2074
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit another
|
|
2075
|
+
* <code>ListInstances</code> request to get the next group of results. Specify the value of
|
|
2128
2076
|
* <code>NextToken</code> from the previous response in the next request.</p>
|
|
2129
2077
|
* @public
|
|
2130
2078
|
*/
|
|
@@ -2144,8 +2092,8 @@ export declare const NamespaceFilterName: {
|
|
|
2144
2092
|
*/
|
|
2145
2093
|
export type NamespaceFilterName = (typeof NamespaceFilterName)[keyof typeof NamespaceFilterName];
|
|
2146
2094
|
/**
|
|
2147
|
-
* <p>A complex type that identifies the namespaces that you want to list. You can choose to list
|
|
2148
|
-
*
|
|
2095
|
+
* <p>A complex type that identifies the namespaces that you want to list. You can choose to list public or
|
|
2096
|
+
* private namespaces.</p>
|
|
2149
2097
|
* @public
|
|
2150
2098
|
*/
|
|
2151
2099
|
export interface NamespaceFilter {
|
|
@@ -2169,18 +2117,17 @@ export interface NamespaceFilter {
|
|
|
2169
2117
|
*/
|
|
2170
2118
|
Name: NamespaceFilterName | undefined;
|
|
2171
2119
|
/**
|
|
2172
|
-
* <p>Specify the values that are applicable to the value that you specify for
|
|
2173
|
-
* <code>Name</code>.</p>
|
|
2120
|
+
* <p>Specify the values that are applicable to the value that you specify for <code>Name</code>.</p>
|
|
2174
2121
|
* <ul>
|
|
2175
2122
|
* <li>
|
|
2176
2123
|
* <p>
|
|
2177
2124
|
* <code>TYPE</code>: Specify <code>HTTP</code>, <code>DNS_PUBLIC</code>, or
|
|
2178
|
-
*
|
|
2125
|
+
* <code>DNS_PRIVATE</code>.</p>
|
|
2179
2126
|
* </li>
|
|
2180
2127
|
* <li>
|
|
2181
2128
|
* <p>
|
|
2182
2129
|
* <code>NAME</code>: Specify the name of the namespace, which is found in
|
|
2183
|
-
*
|
|
2130
|
+
* <code>Namespace.Name</code>.</p>
|
|
2184
2131
|
* </li>
|
|
2185
2132
|
* <li>
|
|
2186
2133
|
* <p>
|
|
@@ -2192,20 +2139,20 @@ export interface NamespaceFilter {
|
|
|
2192
2139
|
*/
|
|
2193
2140
|
Values: string[] | undefined;
|
|
2194
2141
|
/**
|
|
2195
|
-
* <p>Specify the operator that you want to use to determine whether a namespace matches the
|
|
2196
|
-
*
|
|
2142
|
+
* <p>Specify the operator that you want to use to determine whether a namespace matches the specified value.
|
|
2143
|
+
* Valid values for <code>Condition</code> are one of the following.</p>
|
|
2197
2144
|
* <ul>
|
|
2198
2145
|
* <li>
|
|
2199
2146
|
* <p>
|
|
2200
|
-
* <code>EQ</code>: When you specify <code>EQ</code> for <code>Condition</code>, you can
|
|
2201
|
-
*
|
|
2202
|
-
*
|
|
2147
|
+
* <code>EQ</code>: When you specify <code>EQ</code> for <code>Condition</code>, you can specify only one
|
|
2148
|
+
* value. <code>EQ</code> is supported for <code>TYPE</code>, <code>NAME</code>, and <code>HTTP_NAME</code>.
|
|
2149
|
+
* <code>EQ</code> is the default condition and can be omitted.</p>
|
|
2203
2150
|
* </li>
|
|
2204
2151
|
* <li>
|
|
2205
2152
|
* <p>
|
|
2206
|
-
* <code>BEGINS_WITH</code>: When you specify <code>BEGINS_WITH</code> for
|
|
2207
|
-
*
|
|
2208
|
-
*
|
|
2153
|
+
* <code>BEGINS_WITH</code>: When you specify <code>BEGINS_WITH</code> for <code>Condition</code>, you can
|
|
2154
|
+
* specify only one value. <code>BEGINS_WITH</code> is supported for <code>TYPE</code>, <code>NAME</code>, and
|
|
2155
|
+
* <code>HTTP_NAME</code>.</p>
|
|
2209
2156
|
* </li>
|
|
2210
2157
|
* </ul>
|
|
2211
2158
|
* @public
|
|
@@ -2218,22 +2165,22 @@ export interface NamespaceFilter {
|
|
|
2218
2165
|
export interface ListNamespacesRequest {
|
|
2219
2166
|
/**
|
|
2220
2167
|
* <p>For the first <code>ListNamespaces</code> request, omit this value.</p>
|
|
2221
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
2222
|
-
*
|
|
2223
|
-
*
|
|
2168
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code> request to get
|
|
2169
|
+
* the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
|
|
2170
|
+
* request.</p>
|
|
2224
2171
|
* <note>
|
|
2225
|
-
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
2226
|
-
*
|
|
2227
|
-
*
|
|
2228
|
-
*
|
|
2172
|
+
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the specified criteria.
|
|
2173
|
+
* It's possible that no namespaces in the first <code>MaxResults</code> namespaces matched the specified criteria
|
|
2174
|
+
* but that subsequent groups of <code>MaxResults</code> namespaces do contain namespaces that match the
|
|
2175
|
+
* criteria.</p>
|
|
2229
2176
|
* </note>
|
|
2230
2177
|
* @public
|
|
2231
2178
|
*/
|
|
2232
2179
|
NextToken?: string;
|
|
2233
2180
|
/**
|
|
2234
2181
|
* <p>The maximum number of namespaces that you want Cloud Map to return in the response to a
|
|
2235
|
-
* <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2236
|
-
*
|
|
2182
|
+
* <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map
|
|
2183
|
+
* returns up to 100 namespaces.</p>
|
|
2237
2184
|
* @public
|
|
2238
2185
|
*/
|
|
2239
2186
|
MaxResults?: number;
|
|
@@ -2261,8 +2208,8 @@ export interface NamespaceSummary {
|
|
|
2261
2208
|
*/
|
|
2262
2209
|
Arn?: string;
|
|
2263
2210
|
/**
|
|
2264
|
-
* <p>The name of the namespace. When you create a namespace, Cloud Map automatically creates a
|
|
2265
|
-
*
|
|
2211
|
+
* <p>The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted
|
|
2212
|
+
* zone that has the same name as the namespace.</p>
|
|
2266
2213
|
* @public
|
|
2267
2214
|
*/
|
|
2268
2215
|
Name?: string;
|
|
@@ -2297,20 +2244,20 @@ export interface NamespaceSummary {
|
|
|
2297
2244
|
*/
|
|
2298
2245
|
export interface ListNamespacesResponse {
|
|
2299
2246
|
/**
|
|
2300
|
-
* <p>An array that contains one <code>NamespaceSummary</code> object for each namespace that
|
|
2301
|
-
*
|
|
2247
|
+
* <p>An array that contains one <code>NamespaceSummary</code> object for each namespace that matches the
|
|
2248
|
+
* specified filter criteria.</p>
|
|
2302
2249
|
* @public
|
|
2303
2250
|
*/
|
|
2304
2251
|
Namespaces?: NamespaceSummary[];
|
|
2305
2252
|
/**
|
|
2306
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
2307
|
-
*
|
|
2308
|
-
*
|
|
2253
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code> request to get
|
|
2254
|
+
* the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
|
|
2255
|
+
* request.</p>
|
|
2309
2256
|
* <note>
|
|
2310
|
-
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
2311
|
-
*
|
|
2312
|
-
*
|
|
2313
|
-
*
|
|
2257
|
+
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the specified criteria.
|
|
2258
|
+
* It's possible that no namespaces in the first <code>MaxResults</code> namespaces matched the specified criteria
|
|
2259
|
+
* but that subsequent groups of <code>MaxResults</code> namespaces do contain namespaces that match the
|
|
2260
|
+
* criteria.</p>
|
|
2314
2261
|
* </note>
|
|
2315
2262
|
* @public
|
|
2316
2263
|
*/
|
|
@@ -2341,19 +2288,16 @@ export interface OperationFilter {
|
|
|
2341
2288
|
* <ul>
|
|
2342
2289
|
* <li>
|
|
2343
2290
|
* <p>
|
|
2344
|
-
* <b>NAMESPACE_ID</b>: Gets operations related to specified
|
|
2345
|
-
* namespaces.</p>
|
|
2291
|
+
* <b>NAMESPACE_ID</b>: Gets operations related to specified namespaces.</p>
|
|
2346
2292
|
* </li>
|
|
2347
2293
|
* <li>
|
|
2348
2294
|
* <p>
|
|
2349
|
-
* <b>SERVICE_ID</b>: Gets operations related to specified
|
|
2350
|
-
* services.</p>
|
|
2295
|
+
* <b>SERVICE_ID</b>: Gets operations related to specified services.</p>
|
|
2351
2296
|
* </li>
|
|
2352
2297
|
* <li>
|
|
2353
2298
|
* <p>
|
|
2354
|
-
* <b>STATUS</b>: Gets operations based on the status of the
|
|
2355
|
-
*
|
|
2356
|
-
* <code>FAIL</code>.</p>
|
|
2299
|
+
* <b>STATUS</b>: Gets operations based on the status of the operations:
|
|
2300
|
+
* <code>SUBMITTED</code>, <code>PENDING</code>, <code>SUCCEED</code>, or <code>FAIL</code>.</p>
|
|
2357
2301
|
* </li>
|
|
2358
2302
|
* <li>
|
|
2359
2303
|
* <p>
|
|
@@ -2361,8 +2305,8 @@ export interface OperationFilter {
|
|
|
2361
2305
|
* </li>
|
|
2362
2306
|
* <li>
|
|
2363
2307
|
* <p>
|
|
2364
|
-
* <b>UPDATE_DATE</b>: Gets operations that changed status during a
|
|
2365
|
-
*
|
|
2308
|
+
* <b>UPDATE_DATE</b>: Gets operations that changed status during a specified
|
|
2309
|
+
* date/time range. </p>
|
|
2366
2310
|
* </li>
|
|
2367
2311
|
* </ul>
|
|
2368
2312
|
* @public
|
|
@@ -2381,9 +2325,8 @@ export interface OperationFilter {
|
|
|
2381
2325
|
* </li>
|
|
2382
2326
|
* <li>
|
|
2383
2327
|
* <p>
|
|
2384
|
-
* <b>STATUS</b>: Specify one or more statuses:
|
|
2385
|
-
* <code>
|
|
2386
|
-
* <code>FAIL</code>.</p>
|
|
2328
|
+
* <b>STATUS</b>: Specify one or more statuses: <code>SUBMITTED</code>,
|
|
2329
|
+
* <code>PENDING</code>, <code>SUCCEED</code>, or <code>FAIL</code>.</p>
|
|
2387
2330
|
* </li>
|
|
2388
2331
|
* <li>
|
|
2389
2332
|
* <p>
|
|
@@ -2393,37 +2336,34 @@ export interface OperationFilter {
|
|
|
2393
2336
|
* </li>
|
|
2394
2337
|
* <li>
|
|
2395
2338
|
* <p>
|
|
2396
|
-
* <b>UPDATE_DATE</b>: Specify a start date and an end date in Unix
|
|
2397
|
-
*
|
|
2398
|
-
* value.</p>
|
|
2339
|
+
* <b>UPDATE_DATE</b>: Specify a start date and an end date in Unix date/time
|
|
2340
|
+
* format and Coordinated Universal Time (UTC). The start date must be the first value.</p>
|
|
2399
2341
|
* </li>
|
|
2400
2342
|
* </ul>
|
|
2401
2343
|
* @public
|
|
2402
2344
|
*/
|
|
2403
2345
|
Values: string[] | undefined;
|
|
2404
2346
|
/**
|
|
2405
|
-
* <p>The operator that you want to use to determine whether an operation matches the specified
|
|
2406
|
-
*
|
|
2347
|
+
* <p>The operator that you want to use to determine whether an operation matches the specified value. Valid
|
|
2348
|
+
* values for condition include:</p>
|
|
2407
2349
|
* <ul>
|
|
2408
2350
|
* <li>
|
|
2409
2351
|
* <p>
|
|
2410
|
-
* <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only
|
|
2411
|
-
*
|
|
2412
|
-
* <code>
|
|
2413
|
-
* be omitted.</p>
|
|
2352
|
+
* <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only one value.
|
|
2353
|
+
* <code>EQ</code> is supported for <code>NAMESPACE_ID</code>, <code>SERVICE_ID</code>, <code>STATUS</code>, and
|
|
2354
|
+
* <code>TYPE</code>. <code>EQ</code> is the default condition and can be omitted.</p>
|
|
2414
2355
|
* </li>
|
|
2415
2356
|
* <li>
|
|
2416
2357
|
* <p>
|
|
2417
|
-
* <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a
|
|
2418
|
-
*
|
|
2419
|
-
*
|
|
2420
|
-
* response.</p>
|
|
2358
|
+
* <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a list of one or
|
|
2359
|
+
* more values. <code>IN</code> is supported for <code>STATUS</code> and <code>TYPE</code>. An operation must
|
|
2360
|
+
* match one of the specified values to be returned in the response.</p>
|
|
2421
2361
|
* </li>
|
|
2422
2362
|
* <li>
|
|
2423
2363
|
* <p>
|
|
2424
|
-
* <code>BETWEEN</code>: Specify a start date and an end date in Unix date/time format and
|
|
2425
|
-
*
|
|
2426
|
-
*
|
|
2364
|
+
* <code>BETWEEN</code>: Specify a start date and an end date in Unix date/time format and Coordinated
|
|
2365
|
+
* Universal Time (UTC). The start date must be the first value. <code>BETWEEN</code> is supported for
|
|
2366
|
+
* <code>UPDATE_DATE</code>. </p>
|
|
2427
2367
|
* </li>
|
|
2428
2368
|
* </ul>
|
|
2429
2369
|
* @public
|
|
@@ -2436,28 +2376,28 @@ export interface OperationFilter {
|
|
|
2436
2376
|
export interface ListOperationsRequest {
|
|
2437
2377
|
/**
|
|
2438
2378
|
* <p>For the first <code>ListOperations</code> request, omit this value.</p>
|
|
2439
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
2440
|
-
*
|
|
2441
|
-
*
|
|
2379
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code> request to get
|
|
2380
|
+
* the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
|
|
2381
|
+
* request.</p>
|
|
2442
2382
|
* <note>
|
|
2443
|
-
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
2444
|
-
*
|
|
2445
|
-
*
|
|
2446
|
-
*
|
|
2383
|
+
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the specified criteria.
|
|
2384
|
+
* It's possible that no operations in the first <code>MaxResults</code> operations matched the specified criteria
|
|
2385
|
+
* but that subsequent groups of <code>MaxResults</code> operations do contain operations that match the
|
|
2386
|
+
* criteria.</p>
|
|
2447
2387
|
* </note>
|
|
2448
2388
|
* @public
|
|
2449
2389
|
*/
|
|
2450
2390
|
NextToken?: string;
|
|
2451
2391
|
/**
|
|
2452
2392
|
* <p>The maximum number of items that you want Cloud Map to return in the response to a
|
|
2453
|
-
* <code>ListOperations</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2454
|
-
*
|
|
2393
|
+
* <code>ListOperations</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map
|
|
2394
|
+
* returns up to 100 operations.</p>
|
|
2455
2395
|
* @public
|
|
2456
2396
|
*/
|
|
2457
2397
|
MaxResults?: number;
|
|
2458
2398
|
/**
|
|
2459
|
-
* <p>A complex type that contains specifications for the operations that you want to list, for
|
|
2460
|
-
*
|
|
2399
|
+
* <p>A complex type that contains specifications for the operations that you want to list, for example,
|
|
2400
|
+
* operations that you started between a specified start date and end date.</p>
|
|
2461
2401
|
* <p>If you specify more than one filter, an operation must match all filters to be returned by
|
|
2462
2402
|
* <code>ListOperations</code>.</p>
|
|
2463
2403
|
* @public
|
|
@@ -2465,8 +2405,9 @@ export interface ListOperationsRequest {
|
|
|
2465
2405
|
Filters?: OperationFilter[];
|
|
2466
2406
|
}
|
|
2467
2407
|
/**
|
|
2468
|
-
* <p>A complex type that contains information about an operation that matches the criteria that
|
|
2469
|
-
*
|
|
2408
|
+
* <p>A complex type that contains information about an operation that matches the criteria that you specified in
|
|
2409
|
+
* a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html">ListOperations</a>
|
|
2410
|
+
* request.</p>
|
|
2470
2411
|
* @public
|
|
2471
2412
|
*/
|
|
2472
2413
|
export interface OperationSummary {
|
|
@@ -2480,8 +2421,8 @@ export interface OperationSummary {
|
|
|
2480
2421
|
* <ul>
|
|
2481
2422
|
* <li>
|
|
2482
2423
|
* <p>
|
|
2483
|
-
* <b>SUBMITTED</b>: This is the initial state immediately after
|
|
2484
|
-
*
|
|
2424
|
+
* <b>SUBMITTED</b>: This is the initial state immediately after you submit a
|
|
2425
|
+
* request.</p>
|
|
2485
2426
|
* </li>
|
|
2486
2427
|
* <li>
|
|
2487
2428
|
* <p>
|
|
@@ -2511,14 +2452,14 @@ export interface ListOperationsResponse {
|
|
|
2511
2452
|
*/
|
|
2512
2453
|
Operations?: OperationSummary[];
|
|
2513
2454
|
/**
|
|
2514
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
2515
|
-
*
|
|
2516
|
-
*
|
|
2455
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code> request to get
|
|
2456
|
+
* the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
|
|
2457
|
+
* request.</p>
|
|
2517
2458
|
* <note>
|
|
2518
|
-
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
2519
|
-
*
|
|
2520
|
-
*
|
|
2521
|
-
*
|
|
2459
|
+
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the specified criteria.
|
|
2460
|
+
* It's possible that no operations in the first <code>MaxResults</code> operations matched the specified criteria
|
|
2461
|
+
* but that subsequent groups of <code>MaxResults</code> operations do contain operations that match the
|
|
2462
|
+
* criteria.</p>
|
|
2522
2463
|
* </note>
|
|
2523
2464
|
* @public
|
|
2524
2465
|
*/
|
|
@@ -2536,8 +2477,7 @@ export declare const ServiceFilterName: {
|
|
|
2536
2477
|
*/
|
|
2537
2478
|
export type ServiceFilterName = (typeof ServiceFilterName)[keyof typeof ServiceFilterName];
|
|
2538
2479
|
/**
|
|
2539
|
-
* <p>A complex type that lets you specify the namespaces that you want to list services
|
|
2540
|
-
* for.</p>
|
|
2480
|
+
* <p>A complex type that lets you specify the namespaces that you want to list services for.</p>
|
|
2541
2481
|
* @public
|
|
2542
2482
|
*/
|
|
2543
2483
|
export interface ServiceFilter {
|
|
@@ -2547,19 +2487,19 @@ export interface ServiceFilter {
|
|
|
2547
2487
|
*/
|
|
2548
2488
|
Name: ServiceFilterName | undefined;
|
|
2549
2489
|
/**
|
|
2550
|
-
* <p>The values that are applicable to the value that you specify for <code>Condition</code> to
|
|
2551
|
-
*
|
|
2490
|
+
* <p>The values that are applicable to the value that you specify for <code>Condition</code> to filter the list
|
|
2491
|
+
* of services.</p>
|
|
2552
2492
|
* @public
|
|
2553
2493
|
*/
|
|
2554
2494
|
Values: string[] | undefined;
|
|
2555
2495
|
/**
|
|
2556
|
-
* <p>The operator that you want to use to determine whether a service is returned by
|
|
2557
|
-
*
|
|
2496
|
+
* <p>The operator that you want to use to determine whether a service is returned by <code>ListServices</code>.
|
|
2497
|
+
* Valid values for <code>Condition</code> include the following:</p>
|
|
2558
2498
|
* <ul>
|
|
2559
2499
|
* <li>
|
|
2560
2500
|
* <p>
|
|
2561
|
-
* <code>EQ</code>: When you specify <code>EQ</code>, specify one namespace ID for
|
|
2562
|
-
* <code>
|
|
2501
|
+
* <code>EQ</code>: When you specify <code>EQ</code>, specify one namespace ID for <code>Values</code>.
|
|
2502
|
+
* <code>EQ</code> is the default condition and can be omitted.</p>
|
|
2563
2503
|
* </li>
|
|
2564
2504
|
* </ul>
|
|
2565
2505
|
* @public
|
|
@@ -2572,28 +2512,26 @@ export interface ServiceFilter {
|
|
|
2572
2512
|
export interface ListServicesRequest {
|
|
2573
2513
|
/**
|
|
2574
2514
|
* <p>For the first <code>ListServices</code> request, omit this value.</p>
|
|
2575
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2576
|
-
*
|
|
2577
|
-
*
|
|
2515
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code> request to get
|
|
2516
|
+
* the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
|
|
2517
|
+
* request.</p>
|
|
2578
2518
|
* <note>
|
|
2579
|
-
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2580
|
-
*
|
|
2581
|
-
*
|
|
2582
|
-
* contain services that match the criteria.</p>
|
|
2519
|
+
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the specified criteria.
|
|
2520
|
+
* It's possible that no services in the first <code>MaxResults</code> services matched the specified criteria but
|
|
2521
|
+
* that subsequent groups of <code>MaxResults</code> services do contain services that match the criteria.</p>
|
|
2583
2522
|
* </note>
|
|
2584
2523
|
* @public
|
|
2585
2524
|
*/
|
|
2586
2525
|
NextToken?: string;
|
|
2587
2526
|
/**
|
|
2588
2527
|
* <p>The maximum number of services that you want Cloud Map to return in the response to a
|
|
2589
|
-
* <code>ListServices</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2590
|
-
*
|
|
2528
|
+
* <code>ListServices</code> request. If you don't specify a value for <code>MaxResults</code>, Cloud Map returns
|
|
2529
|
+
* up to 100 services.</p>
|
|
2591
2530
|
* @public
|
|
2592
2531
|
*/
|
|
2593
2532
|
MaxResults?: number;
|
|
2594
2533
|
/**
|
|
2595
|
-
* <p>A complex type that contains specifications for the namespaces that you want to list
|
|
2596
|
-
* services for. </p>
|
|
2534
|
+
* <p>A complex type that contains specifications for the namespaces that you want to list services for. </p>
|
|
2597
2535
|
* <p>If you specify more than one filter, an operation must match all filters to be returned by
|
|
2598
2536
|
* <code>ListServices</code>.</p>
|
|
2599
2537
|
* @public
|
|
@@ -2625,8 +2563,8 @@ export interface ServiceSummary {
|
|
|
2625
2563
|
* <dl>
|
|
2626
2564
|
* <dt>DNS_HTTP</dt>
|
|
2627
2565
|
* <dd>
|
|
2628
|
-
* <p>The service instances can be discovered using either DNS queries or the
|
|
2629
|
-
*
|
|
2566
|
+
* <p>The service instances can be discovered using either DNS queries or the <code>DiscoverInstances</code>
|
|
2567
|
+
* API operation.</p>
|
|
2630
2568
|
* </dd>
|
|
2631
2569
|
* <dt>HTTP</dt>
|
|
2632
2570
|
* <dd>
|
|
@@ -2647,45 +2585,43 @@ export interface ServiceSummary {
|
|
|
2647
2585
|
*/
|
|
2648
2586
|
Description?: string;
|
|
2649
2587
|
/**
|
|
2650
|
-
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
2651
|
-
*
|
|
2652
|
-
*
|
|
2588
|
+
* <p>The number of instances that are currently associated with the service. Instances that were previously
|
|
2589
|
+
* associated with the service but that are deleted aren't included in the count. The count might not reflect
|
|
2590
|
+
* pending registrations and deregistrations.</p>
|
|
2653
2591
|
* @public
|
|
2654
2592
|
*/
|
|
2655
2593
|
InstanceCount?: number;
|
|
2656
2594
|
/**
|
|
2657
|
-
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
|
|
2658
|
-
*
|
|
2595
|
+
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register an
|
|
2596
|
+
* instance.</p>
|
|
2659
2597
|
* @public
|
|
2660
2598
|
*/
|
|
2661
2599
|
DnsConfig?: DnsConfig;
|
|
2662
2600
|
/**
|
|
2663
2601
|
* <p>
|
|
2664
|
-
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
2665
|
-
*
|
|
2666
|
-
*
|
|
2602
|
+
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health check. If you
|
|
2603
|
+
* specify settings for a health check, Cloud Map associates the health check with the records that you specify in
|
|
2604
|
+
* <code>DnsConfig</code>.</p>
|
|
2667
2605
|
* @public
|
|
2668
2606
|
*/
|
|
2669
2607
|
HealthCheckConfig?: HealthCheckConfig;
|
|
2670
2608
|
/**
|
|
2671
|
-
* <p>Information about an optional custom health check. A custom health check, which requires
|
|
2672
|
-
*
|
|
2673
|
-
*
|
|
2609
|
+
* <p>Information about an optional custom health check. A custom health check, which requires that you use a
|
|
2610
|
+
* third-party health checker to evaluate the health of your resources, is useful in the following
|
|
2611
|
+
* circumstances:</p>
|
|
2674
2612
|
* <ul>
|
|
2675
2613
|
* <li>
|
|
2676
|
-
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
2677
|
-
*
|
|
2678
|
-
*
|
|
2679
|
-
* checker must also be in the VPC.)</p>
|
|
2614
|
+
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the resource isn't
|
|
2615
|
+
* available over the internet. For example, you can use a custom health check when the instance is in an Amazon
|
|
2616
|
+
* VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)</p>
|
|
2680
2617
|
* </li>
|
|
2681
2618
|
* <li>
|
|
2682
|
-
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
2683
|
-
* located.</p>
|
|
2619
|
+
* <p>You want to use a third-party health checker regardless of where your resources are located.</p>
|
|
2684
2620
|
* </li>
|
|
2685
2621
|
* </ul>
|
|
2686
2622
|
* <important>
|
|
2687
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
2688
|
-
*
|
|
2623
|
+
* <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code>
|
|
2624
|
+
* or <code>HealthCheckConfig</code> but not both.</p>
|
|
2689
2625
|
* </important>
|
|
2690
2626
|
* @public
|
|
2691
2627
|
*/
|
|
@@ -2701,20 +2637,19 @@ export interface ServiceSummary {
|
|
|
2701
2637
|
*/
|
|
2702
2638
|
export interface ListServicesResponse {
|
|
2703
2639
|
/**
|
|
2704
|
-
* <p>An array that contains one <code>ServiceSummary</code> object for each service that matches
|
|
2705
|
-
*
|
|
2640
|
+
* <p>An array that contains one <code>ServiceSummary</code> object for each service that matches the specified
|
|
2641
|
+
* filter criteria.</p>
|
|
2706
2642
|
* @public
|
|
2707
2643
|
*/
|
|
2708
2644
|
Services?: ServiceSummary[];
|
|
2709
2645
|
/**
|
|
2710
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2711
|
-
*
|
|
2712
|
-
*
|
|
2646
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code> request to get
|
|
2647
|
+
* the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next
|
|
2648
|
+
* request.</p>
|
|
2713
2649
|
* <note>
|
|
2714
|
-
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2715
|
-
*
|
|
2716
|
-
*
|
|
2717
|
-
* contain services that match the criteria.</p>
|
|
2650
|
+
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the specified criteria.
|
|
2651
|
+
* It's possible that no services in the first <code>MaxResults</code> services matched the specified criteria but
|
|
2652
|
+
* that subsequent groups of <code>MaxResults</code> services do contain services that match the criteria.</p>
|
|
2718
2653
|
* </note>
|
|
2719
2654
|
* @public
|
|
2720
2655
|
*/
|
|
@@ -2754,106 +2689,104 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
2754
2689
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
2755
2690
|
}
|
|
2756
2691
|
/**
|
|
2757
|
-
* <p>Updated Start of
|
|
2758
|
-
*
|
|
2692
|
+
* <p>Updated Start of Authority (SOA)
|
|
2693
|
+
* properties for a public or private DNS namespace.</p>
|
|
2759
2694
|
* @public
|
|
2760
2695
|
*/
|
|
2761
2696
|
export interface SOAChange {
|
|
2762
2697
|
/**
|
|
2763
|
-
* <p>The updated time to
|
|
2764
|
-
*
|
|
2698
|
+
* <p>The updated time to live (TTL) for
|
|
2699
|
+
* purposes of negative caching.</p>
|
|
2765
2700
|
* @public
|
|
2766
2701
|
*/
|
|
2767
2702
|
TTL: number | undefined;
|
|
2768
2703
|
}
|
|
2769
2704
|
/**
|
|
2770
|
-
* <p>Updated DNS
|
|
2771
|
-
*
|
|
2705
|
+
* <p>Updated DNS properties for the
|
|
2706
|
+
* private DNS namespace.</p>
|
|
2772
2707
|
* @public
|
|
2773
2708
|
*/
|
|
2774
2709
|
export interface PrivateDnsPropertiesMutableChange {
|
|
2775
2710
|
/**
|
|
2776
|
-
* <p>Updated fields for
|
|
2777
|
-
*
|
|
2778
|
-
* namespace.</p>
|
|
2711
|
+
* <p>Updated fields for the Start of
|
|
2712
|
+
* Authority (SOA) record for the hosted zone for the private DNS namespace.</p>
|
|
2779
2713
|
* @public
|
|
2780
2714
|
*/
|
|
2781
2715
|
SOA: SOAChange | undefined;
|
|
2782
2716
|
}
|
|
2783
2717
|
/**
|
|
2784
|
-
* <p>Updated properties
|
|
2785
|
-
*
|
|
2718
|
+
* <p>Updated properties for the private
|
|
2719
|
+
* DNS namespace.</p>
|
|
2786
2720
|
* @public
|
|
2787
2721
|
*/
|
|
2788
2722
|
export interface PrivateDnsNamespacePropertiesChange {
|
|
2789
2723
|
/**
|
|
2790
|
-
* <p>Updated DNS
|
|
2791
|
-
*
|
|
2724
|
+
* <p>Updated DNS properties for the
|
|
2725
|
+
* private DNS namespace.</p>
|
|
2792
2726
|
* @public
|
|
2793
2727
|
*/
|
|
2794
2728
|
DnsProperties: PrivateDnsPropertiesMutableChange | undefined;
|
|
2795
2729
|
}
|
|
2796
2730
|
/**
|
|
2797
|
-
* <p>Updated properties
|
|
2798
|
-
*
|
|
2731
|
+
* <p>Updated properties for the private
|
|
2732
|
+
* DNS namespace.</p>
|
|
2799
2733
|
* @public
|
|
2800
2734
|
*/
|
|
2801
2735
|
export interface PrivateDnsNamespaceChange {
|
|
2802
2736
|
/**
|
|
2803
|
-
* <p>An updated
|
|
2804
|
-
*
|
|
2737
|
+
* <p>An updated description for the
|
|
2738
|
+
* private DNS namespace.</p>
|
|
2805
2739
|
* @public
|
|
2806
2740
|
*/
|
|
2807
2741
|
Description?: string;
|
|
2808
2742
|
/**
|
|
2809
|
-
* <p>Properties to be
|
|
2810
|
-
*
|
|
2743
|
+
* <p>Properties to be updated in the
|
|
2744
|
+
* private DNS namespace.</p>
|
|
2811
2745
|
* @public
|
|
2812
2746
|
*/
|
|
2813
2747
|
Properties?: PrivateDnsNamespacePropertiesChange;
|
|
2814
2748
|
}
|
|
2815
2749
|
/**
|
|
2816
|
-
* <p>Updated DNS
|
|
2817
|
-
*
|
|
2750
|
+
* <p>Updated DNS properties for the
|
|
2751
|
+
* public DNS namespace.</p>
|
|
2818
2752
|
* @public
|
|
2819
2753
|
*/
|
|
2820
2754
|
export interface PublicDnsPropertiesMutableChange {
|
|
2821
2755
|
/**
|
|
2822
|
-
* <p>Updated fields for
|
|
2823
|
-
*
|
|
2824
|
-
* namespace.</p>
|
|
2756
|
+
* <p>Updated fields for the Start of
|
|
2757
|
+
* Authority (SOA) record for the hosted zone for the public DNS namespace.</p>
|
|
2825
2758
|
* @public
|
|
2826
2759
|
*/
|
|
2827
2760
|
SOA: SOAChange | undefined;
|
|
2828
2761
|
}
|
|
2829
2762
|
/**
|
|
2830
|
-
* <p>Updated properties
|
|
2831
|
-
*
|
|
2763
|
+
* <p>Updated properties for the public
|
|
2764
|
+
* DNS namespace.</p>
|
|
2832
2765
|
* @public
|
|
2833
2766
|
*/
|
|
2834
2767
|
export interface PublicDnsNamespacePropertiesChange {
|
|
2835
2768
|
/**
|
|
2836
|
-
* <p>Updated DNS
|
|
2837
|
-
*
|
|
2769
|
+
* <p>Updated DNS properties for the
|
|
2770
|
+
* hosted zone for the public DNS namespace.</p>
|
|
2838
2771
|
* @public
|
|
2839
2772
|
*/
|
|
2840
2773
|
DnsProperties: PublicDnsPropertiesMutableChange | undefined;
|
|
2841
2774
|
}
|
|
2842
2775
|
/**
|
|
2843
|
-
* <p>Updated properties
|
|
2844
|
-
*
|
|
2776
|
+
* <p>Updated properties for the public
|
|
2777
|
+
* DNS namespace.</p>
|
|
2845
2778
|
* @public
|
|
2846
2779
|
*/
|
|
2847
2780
|
export interface PublicDnsNamespaceChange {
|
|
2848
2781
|
/**
|
|
2849
|
-
* <p>An updated
|
|
2850
|
-
*
|
|
2782
|
+
* <p>An updated description for the
|
|
2783
|
+
* public DNS namespace.</p>
|
|
2851
2784
|
* @public
|
|
2852
2785
|
*/
|
|
2853
2786
|
Description?: string;
|
|
2854
2787
|
/**
|
|
2855
|
-
* <p>Properties to be
|
|
2856
|
-
*
|
|
2788
|
+
* <p>Properties to be updated in the
|
|
2789
|
+
* public DNS namespace.</p>
|
|
2857
2790
|
* @public
|
|
2858
2791
|
*/
|
|
2859
2792
|
Properties?: PublicDnsNamespacePropertiesChange;
|
|
@@ -2871,44 +2804,41 @@ export interface RegisterInstanceRequest {
|
|
|
2871
2804
|
* <p>An identifier that you want to associate with the instance. Note the following:</p>
|
|
2872
2805
|
* <ul>
|
|
2873
2806
|
* <li>
|
|
2874
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
2875
|
-
*
|
|
2876
|
-
*
|
|
2877
|
-
* Type</a>.</p>
|
|
2807
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an <code>SRV</code>
|
|
2808
|
+
* record, the value of <code>InstanceId</code> is automatically included as part of the value for the
|
|
2809
|
+
* <code>SRV</code> record. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type">DnsRecord > Type</a>.</p>
|
|
2878
2810
|
* </li>
|
|
2879
2811
|
* <li>
|
|
2880
2812
|
* <p>You can use this value to update an existing instance.</p>
|
|
2881
2813
|
* </li>
|
|
2882
2814
|
* <li>
|
|
2883
|
-
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
2884
|
-
*
|
|
2815
|
+
* <p>To register a new instance, you must specify a value that's unique among instances that you register by
|
|
2816
|
+
* using the same service. </p>
|
|
2885
2817
|
* </li>
|
|
2886
2818
|
* <li>
|
|
2887
|
-
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
2888
|
-
*
|
|
2889
|
-
*
|
|
2819
|
+
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map updates the
|
|
2820
|
+
* existing DNS records, if any. If there's also an existing health check, Cloud Map deletes the old health
|
|
2821
|
+
* check and creates a new one. </p>
|
|
2890
2822
|
* <note>
|
|
2891
|
-
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
2892
|
-
*
|
|
2823
|
+
* <p>The health check isn't deleted immediately, so it will still appear for a while if you submit a
|
|
2824
|
+
* <code>ListHealthChecks</code> request, for example.</p>
|
|
2893
2825
|
* </note>
|
|
2894
2826
|
* </li>
|
|
2895
2827
|
* </ul>
|
|
2896
2828
|
* <note>
|
|
2897
|
-
* <p>Do not include sensitive information in <code>InstanceId</code> if the namespace is
|
|
2898
|
-
*
|
|
2899
|
-
*
|
|
2900
|
-
* public DNS queries.</p>
|
|
2829
|
+
* <p>Do not include sensitive information in <code>InstanceId</code> if the namespace is discoverable by public
|
|
2830
|
+
* DNS queries and any <code>Type</code> member of <code>DnsRecord</code> for the service contains
|
|
2831
|
+
* <code>SRV</code> because the <code>InstanceId</code> is discoverable by public DNS queries.</p>
|
|
2901
2832
|
* </note>
|
|
2902
2833
|
* @public
|
|
2903
2834
|
*/
|
|
2904
2835
|
InstanceId: string | undefined;
|
|
2905
2836
|
/**
|
|
2906
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
2907
|
-
*
|
|
2908
|
-
*
|
|
2909
|
-
*
|
|
2910
|
-
*
|
|
2911
|
-
* date/time stamp).</p>
|
|
2837
|
+
* <p>A unique string that identifies the request and that allows failed <code>RegisterInstance</code> requests
|
|
2838
|
+
* to be retried without the risk of executing the operation twice. You must use a unique
|
|
2839
|
+
* <code>CreatorRequestId</code> string every time you submit a <code>RegisterInstance</code> request if you're
|
|
2840
|
+
* registering additional instances for the same namespace and service. <code>CreatorRequestId</code> can be any
|
|
2841
|
+
* unique string (for example, a date/time stamp).</p>
|
|
2912
2842
|
* @public
|
|
2913
2843
|
*/
|
|
2914
2844
|
CreatorRequestId?: string;
|
|
@@ -2923,39 +2853,43 @@ export interface RegisterInstanceRequest {
|
|
|
2923
2853
|
* <p>For each attribute, the applicable value.</p>
|
|
2924
2854
|
* </li>
|
|
2925
2855
|
* </ul>
|
|
2926
|
-
* <
|
|
2927
|
-
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by
|
|
2928
|
-
*
|
|
2929
|
-
* </
|
|
2930
|
-
* <p>
|
|
2856
|
+
* <important>
|
|
2857
|
+
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by public DNS
|
|
2858
|
+
* queries.</p>
|
|
2859
|
+
* </important>
|
|
2860
|
+
* <p>The following are the supported attribute keys.</p>
|
|
2931
2861
|
* <dl>
|
|
2932
2862
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
2933
2863
|
* <dd>
|
|
2934
|
-
* <p>If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an
|
|
2935
|
-
*
|
|
2936
|
-
*
|
|
2864
|
+
* <p>If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load
|
|
2865
|
+
* balancer, specify the DNS name that's associated with the load balancer. For information about how to get the
|
|
2866
|
+
* DNS name, see "DNSName" in the topic <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html">AliasTarget</a> in the
|
|
2867
|
+
* <i>Route 53 API Reference</i>.</p>
|
|
2937
2868
|
* <p>Note the following:</p>
|
|
2938
2869
|
* <ul>
|
|
2939
2870
|
* <li>
|
|
2940
|
-
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
2941
|
-
*
|
|
2871
|
+
* <p>The configuration for the service that's specified by <code>ServiceId</code> must include settings for
|
|
2872
|
+
* an <code>A</code> record, an <code>AAAA</code> record, or both.</p>
|
|
2873
|
+
* </li>
|
|
2874
|
+
* <li>
|
|
2875
|
+
* <p>In the service that's specified by <code>ServiceId</code>, the value of <code>RoutingPolicy</code>
|
|
2876
|
+
* must be <code>WEIGHTED</code>.</p>
|
|
2942
2877
|
* </li>
|
|
2943
2878
|
* <li>
|
|
2944
|
-
* <p>
|
|
2945
|
-
*
|
|
2879
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes <code>HealthCheckConfig</code>
|
|
2880
|
+
* settings, Cloud Map will create the Route 53 health check, but it doesn't associate the health check with the
|
|
2881
|
+
* alias record.</p>
|
|
2946
2882
|
* </li>
|
|
2947
2883
|
* <li>
|
|
2948
|
-
* <p>
|
|
2949
|
-
*
|
|
2950
|
-
* it doesn't associate the health check with the alias record.</p>
|
|
2884
|
+
* <p>Cloud Map currently doesn't support creating alias records that route traffic to Amazon Web Services
|
|
2885
|
+
* resources other than Elastic Load Balancing load balancers.</p>
|
|
2951
2886
|
* </li>
|
|
2952
2887
|
* <li>
|
|
2953
|
-
* <p>
|
|
2954
|
-
*
|
|
2888
|
+
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for any of the
|
|
2889
|
+
* <code>AWS_INSTANCE</code> attributes.</p>
|
|
2955
2890
|
* </li>
|
|
2956
2891
|
* <li>
|
|
2957
|
-
* <p>
|
|
2958
|
-
* any of the <code>AWS_INSTANCE</code> attributes.</p>
|
|
2892
|
+
* <p>The <code>AWS_ALIAS_DNS_NAME</code> is not supported in the GovCloud (US) Regions.</p>
|
|
2959
2893
|
* </li>
|
|
2960
2894
|
* </ul>
|
|
2961
2895
|
* </dd>
|
|
@@ -2963,61 +2897,56 @@ export interface RegisterInstanceRequest {
|
|
|
2963
2897
|
* <dd>
|
|
2964
2898
|
* <p>
|
|
2965
2899
|
* <i>HTTP namespaces only.</i> The Amazon EC2 instance ID for the instance. If the
|
|
2966
|
-
* <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the only other attribute that
|
|
2967
|
-
*
|
|
2968
|
-
*
|
|
2969
|
-
* <code>AWS_INSTANCE_IPV4</code> attribute will be filled out with the primary private IPv4
|
|
2900
|
+
* <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the only other attribute that can be specified
|
|
2901
|
+
* is <code>AWS_INIT_HEALTH_STATUS</code>. When the <code>AWS_EC2_INSTANCE_ID</code> attribute is specified,
|
|
2902
|
+
* then the <code>AWS_INSTANCE_IPV4</code> attribute will be filled out with the primary private IPv4
|
|
2970
2903
|
* address.</p>
|
|
2971
2904
|
* </dd>
|
|
2972
2905
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
2973
2906
|
* <dd>
|
|
2974
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
2975
|
-
*
|
|
2976
|
-
*
|
|
2907
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can optionally use
|
|
2908
|
+
* <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom health check,
|
|
2909
|
+
* <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
2977
2910
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
2978
2911
|
* </dd>
|
|
2979
2912
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
2980
2913
|
* <dd>
|
|
2981
|
-
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
2982
|
-
*
|
|
2983
|
-
*
|
|
2984
|
-
*
|
|
2985
|
-
* settings for an <code>CNAME</code> record.</p>
|
|
2914
|
+
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that you want Route 53
|
|
2915
|
+
* to return in response to DNS queries (for example, <code>example.com</code>).</p>
|
|
2916
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
|
|
2917
|
+
* <code>CNAME</code> record.</p>
|
|
2986
2918
|
* </dd>
|
|
2987
2919
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
2988
2920
|
* <dd>
|
|
2989
|
-
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
2990
|
-
*
|
|
2991
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
2992
|
-
*
|
|
2993
|
-
*
|
|
2994
|
-
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
2921
|
+
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you want Route 53 to
|
|
2922
|
+
* return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
2923
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
|
|
2924
|
+
* <code>A</code> record. If the service includes settings for an <code>SRV</code> record, you must specify a
|
|
2925
|
+
* value for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
2995
2926
|
* </dd>
|
|
2996
2927
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
2997
2928
|
* <dd>
|
|
2998
|
-
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
2999
|
-
*
|
|
3000
|
-
*
|
|
3001
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
3002
|
-
*
|
|
3003
|
-
*
|
|
3004
|
-
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
2929
|
+
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that you want Route 53
|
|
2930
|
+
* to return in response to DNS queries (for example,
|
|
2931
|
+
* <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
2932
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an
|
|
2933
|
+
* <code>AAAA</code> record. If the service includes settings for an <code>SRV</code> record, you must specify
|
|
2934
|
+
* a value for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
3005
2935
|
* </dd>
|
|
3006
2936
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
3007
2937
|
* <dd>
|
|
3008
|
-
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to
|
|
3009
|
-
*
|
|
3010
|
-
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
3011
|
-
*
|
|
3012
|
-
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
3013
|
-
*
|
|
2938
|
+
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to return for the
|
|
2939
|
+
* port.</p>
|
|
2940
|
+
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you want Route 53 to
|
|
2941
|
+
* send requests to. </p>
|
|
2942
|
+
* <p>This value is required if you specified settings for an <code>SRV</code> record or a Route 53 health check
|
|
2943
|
+
* when you created the service.</p>
|
|
3014
2944
|
* </dd>
|
|
3015
2945
|
* <dt>Custom attributes</dt>
|
|
3016
2946
|
* <dd>
|
|
3017
|
-
* <p>You can add up to 30 custom attributes. For each key-value pair, the maximum length of
|
|
3018
|
-
*
|
|
3019
|
-
*
|
|
3020
|
-
* exceed 5,000 characters.</p>
|
|
2947
|
+
* <p>You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute
|
|
2948
|
+
* name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of
|
|
2949
|
+
* all provided attributes (sum of all keys and values) must not exceed 5,000 characters.</p>
|
|
3021
2950
|
* </dd>
|
|
3022
2951
|
* </dl>
|
|
3023
2952
|
* @public
|
|
@@ -3045,8 +2974,8 @@ export interface TagResourceRequest {
|
|
|
3045
2974
|
*/
|
|
3046
2975
|
ResourceARN: string | undefined;
|
|
3047
2976
|
/**
|
|
3048
|
-
* <p>The tags to add to the specified resource. Specifying the tag key is required. You can set
|
|
3049
|
-
*
|
|
2977
|
+
* <p>The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a
|
|
2978
|
+
* tag to an empty string, but you can't set the value of a tag to null.</p>
|
|
3050
2979
|
* @public
|
|
3051
2980
|
*/
|
|
3052
2981
|
Tags: Tag[] | undefined;
|
|
@@ -3081,22 +3010,22 @@ export interface UntagResourceResponse {
|
|
|
3081
3010
|
*/
|
|
3082
3011
|
export interface UpdateHttpNamespaceRequest {
|
|
3083
3012
|
/**
|
|
3084
|
-
* <p>The ID of the
|
|
3085
|
-
*
|
|
3013
|
+
* <p>The ID of the namespace that you
|
|
3014
|
+
* want to update.</p>
|
|
3086
3015
|
* @public
|
|
3087
3016
|
*/
|
|
3088
3017
|
Id: string | undefined;
|
|
3089
3018
|
/**
|
|
3090
|
-
* <p>A unique string that
|
|
3091
|
-
*
|
|
3092
|
-
*
|
|
3093
|
-
*
|
|
3019
|
+
* <p>A unique string that identifies the
|
|
3020
|
+
* request and that allows failed <code>UpdateHttpNamespace</code> requests to be retried without the risk of
|
|
3021
|
+
* running the operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
|
|
3022
|
+
* date/timestamp).</p>
|
|
3094
3023
|
* @public
|
|
3095
3024
|
*/
|
|
3096
3025
|
UpdaterRequestId?: string;
|
|
3097
3026
|
/**
|
|
3098
|
-
* <p>Updated properties
|
|
3099
|
-
*
|
|
3027
|
+
* <p>Updated properties for the the HTTP
|
|
3028
|
+
* namespace.</p>
|
|
3100
3029
|
* @public
|
|
3101
3030
|
*/
|
|
3102
3031
|
Namespace: HttpNamespaceChange | undefined;
|
|
@@ -3117,8 +3046,8 @@ export interface UpdateHttpNamespaceResponse {
|
|
|
3117
3046
|
*/
|
|
3118
3047
|
export interface UpdateInstanceCustomHealthStatusRequest {
|
|
3119
3048
|
/**
|
|
3120
|
-
* <p>The ID of the service that includes the configuration for the custom health check that you
|
|
3121
|
-
*
|
|
3049
|
+
* <p>The ID of the service that includes the configuration for the custom health check that you want to change
|
|
3050
|
+
* the status for.</p>
|
|
3122
3051
|
* @public
|
|
3123
3052
|
*/
|
|
3124
3053
|
ServiceId: string | undefined;
|
|
@@ -3138,22 +3067,22 @@ export interface UpdateInstanceCustomHealthStatusRequest {
|
|
|
3138
3067
|
*/
|
|
3139
3068
|
export interface UpdatePrivateDnsNamespaceRequest {
|
|
3140
3069
|
/**
|
|
3141
|
-
* <p>The ID of the
|
|
3142
|
-
*
|
|
3070
|
+
* <p>The ID of the namespace that you
|
|
3071
|
+
* want to update.</p>
|
|
3143
3072
|
* @public
|
|
3144
3073
|
*/
|
|
3145
3074
|
Id: string | undefined;
|
|
3146
3075
|
/**
|
|
3147
|
-
* <p>A unique string that
|
|
3148
|
-
*
|
|
3149
|
-
*
|
|
3150
|
-
*
|
|
3076
|
+
* <p>A unique string that identifies the
|
|
3077
|
+
* request and that allows failed <code>UpdatePrivateDnsNamespace</code> requests to be retried without the risk of
|
|
3078
|
+
* running the operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
|
|
3079
|
+
* date/timestamp).</p>
|
|
3151
3080
|
* @public
|
|
3152
3081
|
*/
|
|
3153
3082
|
UpdaterRequestId?: string;
|
|
3154
3083
|
/**
|
|
3155
|
-
* <p>Updated properties
|
|
3156
|
-
*
|
|
3084
|
+
* <p>Updated properties for the private
|
|
3085
|
+
* DNS namespace.</p>
|
|
3157
3086
|
* @public
|
|
3158
3087
|
*/
|
|
3159
3088
|
Namespace: PrivateDnsNamespaceChange | undefined;
|
|
@@ -3174,22 +3103,22 @@ export interface UpdatePrivateDnsNamespaceResponse {
|
|
|
3174
3103
|
*/
|
|
3175
3104
|
export interface UpdatePublicDnsNamespaceRequest {
|
|
3176
3105
|
/**
|
|
3177
|
-
* <p>The ID of the
|
|
3178
|
-
*
|
|
3106
|
+
* <p>The ID of the namespace being
|
|
3107
|
+
* updated.</p>
|
|
3179
3108
|
* @public
|
|
3180
3109
|
*/
|
|
3181
3110
|
Id: string | undefined;
|
|
3182
3111
|
/**
|
|
3183
|
-
* <p>A unique string that
|
|
3184
|
-
*
|
|
3185
|
-
*
|
|
3186
|
-
*
|
|
3112
|
+
* <p>A unique string that identifies the
|
|
3113
|
+
* request and that allows failed <code>UpdatePublicDnsNamespace</code> requests to be retried without the risk of
|
|
3114
|
+
* running the operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
|
|
3115
|
+
* date/timestamp).</p>
|
|
3187
3116
|
* @public
|
|
3188
3117
|
*/
|
|
3189
3118
|
UpdaterRequestId?: string;
|
|
3190
3119
|
/**
|
|
3191
|
-
* <p>Updated properties
|
|
3192
|
-
*
|
|
3120
|
+
* <p>Updated properties for the public
|
|
3121
|
+
* DNS namespace.</p>
|
|
3193
3122
|
* @public
|
|
3194
3123
|
*/
|
|
3195
3124
|
Namespace: PublicDnsNamespaceChange | undefined;
|
|
@@ -3216,16 +3145,16 @@ export interface ServiceChange {
|
|
|
3216
3145
|
*/
|
|
3217
3146
|
Description?: string;
|
|
3218
3147
|
/**
|
|
3219
|
-
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
|
|
3220
|
-
*
|
|
3148
|
+
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register an
|
|
3149
|
+
* instance.</p>
|
|
3221
3150
|
* @public
|
|
3222
3151
|
*/
|
|
3223
3152
|
DnsConfig?: DnsConfigChange;
|
|
3224
3153
|
/**
|
|
3225
3154
|
* <p>
|
|
3226
|
-
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
3227
|
-
*
|
|
3228
|
-
*
|
|
3155
|
+
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health check. If you
|
|
3156
|
+
* specify settings for a health check, Cloud Map associates the health check with the records that you specify in
|
|
3157
|
+
* <code>DnsConfig</code>.</p>
|
|
3229
3158
|
* @public
|
|
3230
3159
|
*/
|
|
3231
3160
|
HealthCheckConfig?: HealthCheckConfig;
|