@aws-sdk/client-servicediscovery 3.864.0 → 3.872.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 +6 -5
- package/dist-cjs/index.js +16 -1
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +7 -0
- package/dist-types/ServiceDiscovery.d.ts +6 -5
- package/dist-types/ServiceDiscoveryClient.d.ts +6 -5
- package/dist-types/commands/CreateHttpNamespaceCommand.d.ts +12 -9
- package/dist-types/commands/CreatePrivateDnsNamespaceCommand.d.ts +14 -11
- package/dist-types/commands/CreatePublicDnsNamespaceCommand.d.ts +14 -13
- package/dist-types/commands/CreateServiceCommand.d.ts +14 -10
- package/dist-types/commands/DeleteNamespaceCommand.d.ts +7 -6
- package/dist-types/commands/DeleteServiceAttributesCommand.d.ts +3 -2
- package/dist-types/commands/DeleteServiceCommand.d.ts +7 -6
- package/dist-types/commands/DeregisterInstanceCommand.d.ts +9 -8
- package/dist-types/commands/DiscoverInstancesCommand.d.ts +11 -8
- package/dist-types/commands/DiscoverInstancesRevisionCommand.d.ts +7 -5
- package/dist-types/commands/GetInstanceCommand.d.ts +7 -4
- package/dist-types/commands/GetInstancesHealthStatusCommand.d.ts +10 -8
- package/dist-types/commands/GetNamespaceCommand.d.ts +4 -2
- package/dist-types/commands/GetOperationCommand.d.ts +5 -2
- package/dist-types/commands/GetServiceAttributesCommand.d.ts +4 -2
- package/dist-types/commands/GetServiceCommand.d.ts +5 -2
- package/dist-types/commands/ListInstancesCommand.d.ts +7 -3
- package/dist-types/commands/ListNamespacesCommand.d.ts +6 -4
- package/dist-types/commands/ListOperationsCommand.d.ts +3 -2
- package/dist-types/commands/ListServicesCommand.d.ts +6 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -2
- package/dist-types/commands/RegisterInstanceCommand.d.ts +28 -22
- package/dist-types/commands/TagResourceCommand.d.ts +5 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -2
- package/dist-types/commands/UpdateHttpNamespaceCommand.d.ts +5 -4
- package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +13 -10
- package/dist-types/commands/UpdatePrivateDnsNamespaceCommand.d.ts +5 -4
- package/dist-types/commands/UpdatePublicDnsNamespaceCommand.d.ts +6 -6
- package/dist-types/commands/UpdateServiceAttributesCommand.d.ts +5 -3
- package/dist-types/commands/UpdateServiceCommand.d.ts +24 -7
- package/dist-types/index.d.ts +6 -5
- package/dist-types/models/models_0.d.ts +960 -686
- package/dist-types/ts3.4/models/models_0.d.ts +18 -0
- package/package.json +2 -2
|
@@ -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
|
-
* string, but you can't set the value of a tag to null.</p>
|
|
14
|
+
* <p>The string value that's associated with the key of the tag. You can set the value of a tag
|
|
15
|
+
* to an empty 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,9 +27,10 @@ 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
|
-
* unique string (for example, a date/time
|
|
30
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
31
|
+
* <code>CreateHttpNamespace</code> requests to be retried without the risk of running the
|
|
32
|
+
* operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a date/time
|
|
33
|
+
* stamp).</p>
|
|
33
34
|
* @public
|
|
34
35
|
*/
|
|
35
36
|
CreatorRequestId?: string | undefined;
|
|
@@ -39,8 +40,8 @@ export interface CreateHttpNamespaceRequest {
|
|
|
39
40
|
*/
|
|
40
41
|
Description?: string | undefined;
|
|
41
42
|
/**
|
|
42
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
43
|
-
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
43
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
44
|
+
* define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
44
45
|
* characters in length.</p>
|
|
45
46
|
* @public
|
|
46
47
|
*/
|
|
@@ -76,8 +77,9 @@ export declare class DuplicateRequest extends __BaseException {
|
|
|
76
77
|
constructor(opts: __ExceptionOptionType<DuplicateRequest, __BaseException>);
|
|
77
78
|
}
|
|
78
79
|
/**
|
|
79
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
80
|
-
* might be outside the allowed range, or a string value might exceed length
|
|
80
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
81
|
+
* numeric value might be outside the allowed range, or a string value might exceed length
|
|
82
|
+
* constraints.</p>
|
|
81
83
|
* @public
|
|
82
84
|
*/
|
|
83
85
|
export declare class InvalidInput extends __BaseException {
|
|
@@ -113,7 +115,8 @@ export declare class NamespaceAlreadyExists extends __BaseException {
|
|
|
113
115
|
constructor(opts: __ExceptionOptionType<NamespaceAlreadyExists, __BaseException>);
|
|
114
116
|
}
|
|
115
117
|
/**
|
|
116
|
-
* <p>The resource can't be created because you've reached the quota on the number of
|
|
118
|
+
* <p>The resource can't be created because you've reached the quota on the number of
|
|
119
|
+
* resources.</p>
|
|
117
120
|
* @public
|
|
118
121
|
*/
|
|
119
122
|
export declare class ResourceLimitExceeded extends __BaseException {
|
|
@@ -126,8 +129,8 @@ export declare class ResourceLimitExceeded extends __BaseException {
|
|
|
126
129
|
constructor(opts: __ExceptionOptionType<ResourceLimitExceeded, __BaseException>);
|
|
127
130
|
}
|
|
128
131
|
/**
|
|
129
|
-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
130
|
-
* resource is 50.</p>
|
|
132
|
+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
133
|
+
* applied to a resource is 50.</p>
|
|
131
134
|
* @public
|
|
132
135
|
*/
|
|
133
136
|
export declare class TooManyTagsException extends __BaseException {
|
|
@@ -145,40 +148,41 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
145
148
|
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
146
149
|
}
|
|
147
150
|
/**
|
|
148
|
-
* <p>Start of Authority
|
|
149
|
-
* for a public or private DNS namespace.</p>
|
|
151
|
+
* <p>Start of Authority
|
|
152
|
+
* (SOA) properties for a public or private DNS namespace.</p>
|
|
150
153
|
* @public
|
|
151
154
|
*/
|
|
152
155
|
export interface SOA {
|
|
153
156
|
/**
|
|
154
|
-
* <p>The time to live
|
|
155
|
-
* of negative caching.</p>
|
|
157
|
+
* <p>The time to live
|
|
158
|
+
* (TTL) for purposes of negative caching.</p>
|
|
156
159
|
* @public
|
|
157
160
|
*/
|
|
158
161
|
TTL: number | undefined;
|
|
159
162
|
}
|
|
160
163
|
/**
|
|
161
|
-
* <p>DNS properties for
|
|
162
|
-
* namespace.</p>
|
|
164
|
+
* <p>DNS properties for
|
|
165
|
+
* the private DNS namespace.</p>
|
|
163
166
|
* @public
|
|
164
167
|
*/
|
|
165
168
|
export interface PrivateDnsPropertiesMutable {
|
|
166
169
|
/**
|
|
167
|
-
* <p>Fields for the Start
|
|
168
|
-
* (SOA) record for the hosted zone for the private DNS
|
|
170
|
+
* <p>Fields for the Start
|
|
171
|
+
* of Authority (SOA) record for the hosted zone for the private DNS
|
|
172
|
+
* namespace.</p>
|
|
169
173
|
* @public
|
|
170
174
|
*/
|
|
171
175
|
SOA: SOA | undefined;
|
|
172
176
|
}
|
|
173
177
|
/**
|
|
174
|
-
* <p>DNS properties for
|
|
175
|
-
* namespace.</p>
|
|
178
|
+
* <p>DNS properties for
|
|
179
|
+
* the private DNS namespace.</p>
|
|
176
180
|
* @public
|
|
177
181
|
*/
|
|
178
182
|
export interface PrivateDnsNamespaceProperties {
|
|
179
183
|
/**
|
|
180
|
-
* <p>DNS properties for
|
|
181
|
-
* namespace.</p>
|
|
184
|
+
* <p>DNS properties for
|
|
185
|
+
* the private DNS namespace.</p>
|
|
182
186
|
* @public
|
|
183
187
|
*/
|
|
184
188
|
DnsProperties: PrivateDnsPropertiesMutable | undefined;
|
|
@@ -188,15 +192,17 @@ export interface PrivateDnsNamespaceProperties {
|
|
|
188
192
|
*/
|
|
189
193
|
export interface CreatePrivateDnsNamespaceRequest {
|
|
190
194
|
/**
|
|
191
|
-
* <p>The name that you want to assign to this namespace. When you create a private DNS namespace,
|
|
192
|
-
* automatically creates an Amazon Route 53 private hosted zone that has the same name as the
|
|
195
|
+
* <p>The name that you want to assign to this namespace. When you create a private DNS namespace,
|
|
196
|
+
* Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the
|
|
197
|
+
* namespace.</p>
|
|
193
198
|
* @public
|
|
194
199
|
*/
|
|
195
200
|
Name: string | undefined;
|
|
196
201
|
/**
|
|
197
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
198
|
-
*
|
|
199
|
-
* unique string (for example, a
|
|
202
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
203
|
+
* <code>CreatePrivateDnsNamespace</code> requests to be retried without the risk of running the
|
|
204
|
+
* operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
205
|
+
* date/timestamp).</p>
|
|
200
206
|
* @public
|
|
201
207
|
*/
|
|
202
208
|
CreatorRequestId?: string | undefined;
|
|
@@ -211,15 +217,15 @@ export interface CreatePrivateDnsNamespaceRequest {
|
|
|
211
217
|
*/
|
|
212
218
|
Vpc: string | undefined;
|
|
213
219
|
/**
|
|
214
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
215
|
-
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
220
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
221
|
+
* define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
216
222
|
* characters in length.</p>
|
|
217
223
|
* @public
|
|
218
224
|
*/
|
|
219
225
|
Tags?: Tag[] | undefined;
|
|
220
226
|
/**
|
|
221
|
-
* <p>Properties for the
|
|
222
|
-
* namespace.</p>
|
|
227
|
+
* <p>Properties for the
|
|
228
|
+
* private DNS namespace.</p>
|
|
223
229
|
* @public
|
|
224
230
|
*/
|
|
225
231
|
Properties?: PrivateDnsNamespaceProperties | undefined;
|
|
@@ -236,27 +242,27 @@ export interface CreatePrivateDnsNamespaceResponse {
|
|
|
236
242
|
OperationId?: string | undefined;
|
|
237
243
|
}
|
|
238
244
|
/**
|
|
239
|
-
* <p>DNS properties for
|
|
240
|
-
* namespace.</p>
|
|
245
|
+
* <p>DNS properties for
|
|
246
|
+
* the public DNS namespace.</p>
|
|
241
247
|
* @public
|
|
242
248
|
*/
|
|
243
249
|
export interface PublicDnsPropertiesMutable {
|
|
244
250
|
/**
|
|
245
|
-
* <p>Start of Authority
|
|
246
|
-
* the hosted zone for the public DNS namespace.</p>
|
|
251
|
+
* <p>Start of Authority
|
|
252
|
+
* (SOA) record for the hosted zone for the public DNS namespace.</p>
|
|
247
253
|
* @public
|
|
248
254
|
*/
|
|
249
255
|
SOA: SOA | undefined;
|
|
250
256
|
}
|
|
251
257
|
/**
|
|
252
|
-
* <p>DNS properties for
|
|
253
|
-
* namespace.</p>
|
|
258
|
+
* <p>DNS properties for
|
|
259
|
+
* the public DNS namespace.</p>
|
|
254
260
|
* @public
|
|
255
261
|
*/
|
|
256
262
|
export interface PublicDnsNamespaceProperties {
|
|
257
263
|
/**
|
|
258
|
-
* <p>DNS properties for
|
|
259
|
-
* namespace.</p>
|
|
264
|
+
* <p>DNS properties for
|
|
265
|
+
* the public DNS namespace.</p>
|
|
260
266
|
* @public
|
|
261
267
|
*/
|
|
262
268
|
DnsProperties: PublicDnsPropertiesMutable | undefined;
|
|
@@ -268,15 +274,17 @@ export interface CreatePublicDnsNamespaceRequest {
|
|
|
268
274
|
/**
|
|
269
275
|
* <p>The name that you want to assign to this namespace.</p>
|
|
270
276
|
* <note>
|
|
271
|
-
* <p>Do not include sensitive information in the name. The name is publicly available using DNS
|
|
277
|
+
* <p>Do not include sensitive information in the name. The name is publicly available using DNS
|
|
278
|
+
* queries.</p>
|
|
272
279
|
* </note>
|
|
273
280
|
* @public
|
|
274
281
|
*/
|
|
275
282
|
Name: string | undefined;
|
|
276
283
|
/**
|
|
277
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
278
|
-
*
|
|
279
|
-
* unique string (for example, a
|
|
284
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
285
|
+
* <code>CreatePublicDnsNamespace</code> requests to be retried without the risk of running the
|
|
286
|
+
* operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
287
|
+
* date/timestamp).</p>
|
|
280
288
|
* @public
|
|
281
289
|
*/
|
|
282
290
|
CreatorRequestId?: string | undefined;
|
|
@@ -286,15 +294,15 @@ export interface CreatePublicDnsNamespaceRequest {
|
|
|
286
294
|
*/
|
|
287
295
|
Description?: string | undefined;
|
|
288
296
|
/**
|
|
289
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
290
|
-
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
297
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
298
|
+
* define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
291
299
|
* characters in length.</p>
|
|
292
300
|
* @public
|
|
293
301
|
*/
|
|
294
302
|
Tags?: Tag[] | undefined;
|
|
295
303
|
/**
|
|
296
|
-
* <p>Properties for the
|
|
297
|
-
* namespace.</p>
|
|
304
|
+
* <p>Properties for the
|
|
305
|
+
* public DNS namespace.</p>
|
|
298
306
|
* @public
|
|
299
307
|
*/
|
|
300
308
|
Properties?: PublicDnsNamespaceProperties | undefined;
|
|
@@ -304,8 +312,8 @@ export interface CreatePublicDnsNamespaceRequest {
|
|
|
304
312
|
*/
|
|
305
313
|
export interface CreatePublicDnsNamespaceResponse {
|
|
306
314
|
/**
|
|
307
|
-
* <p>A value that you can use to determine whether the request completed successfully. To get the
|
|
308
|
-
* operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
|
|
315
|
+
* <p>A value that you can use to determine whether the request completed successfully. To get the
|
|
316
|
+
* status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
|
|
309
317
|
* @public
|
|
310
318
|
*/
|
|
311
319
|
OperationId?: string | undefined;
|
|
@@ -325,14 +333,15 @@ export declare const RecordType: {
|
|
|
325
333
|
*/
|
|
326
334
|
export type RecordType = (typeof RecordType)[keyof typeof RecordType];
|
|
327
335
|
/**
|
|
328
|
-
* <p>A complex type that contains information about the Route 53 DNS records that you want
|
|
329
|
-
* when you register an instance.</p>
|
|
336
|
+
* <p>A complex type that contains information about the Route 53 DNS records that you want
|
|
337
|
+
* Cloud Map to create when you register an instance.</p>
|
|
330
338
|
* @public
|
|
331
339
|
*/
|
|
332
340
|
export interface DnsRecord {
|
|
333
341
|
/**
|
|
334
|
-
* <p>The type of the resource, which indicates the type of value that Route 53 returns in response
|
|
335
|
-
* You can specify values for <code>Type</code> in the following
|
|
342
|
+
* <p>The type of the resource, which indicates the type of value that Route 53 returns in response
|
|
343
|
+
* to DNS queries. You can specify values for <code>Type</code> in the following
|
|
344
|
+
* combinations:</p>
|
|
336
345
|
* <ul>
|
|
337
346
|
* <li>
|
|
338
347
|
* <p>
|
|
@@ -372,10 +381,10 @@ export interface DnsRecord {
|
|
|
372
381
|
* </p>
|
|
373
382
|
* </li>
|
|
374
383
|
* </ul>
|
|
375
|
-
* <p>If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
|
|
376
|
-
*
|
|
377
|
-
* <p>You specify other settings, such as the IP address for <code>A</code> and <code>AAAA</code>
|
|
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>
|
|
384
|
+
* <p>If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
|
|
385
|
+
* <code>A</code> or <code>AAAA</code> for <code>Type</code>.</p>
|
|
386
|
+
* <p>You specify other settings, such as the IP address for <code>A</code> and <code>AAAA</code>
|
|
387
|
+
* records, when 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>
|
|
379
388
|
* <p>The following values are supported:</p>
|
|
380
389
|
* <dl>
|
|
381
390
|
* <dt>A</dt>
|
|
@@ -389,44 +398,49 @@ export interface DnsRecord {
|
|
|
389
398
|
* </dd>
|
|
390
399
|
* <dt>CNAME</dt>
|
|
391
400
|
* <dd>
|
|
392
|
-
* <p>Route 53 returns the domain name of the resource, such as www.example.com. Note the
|
|
401
|
+
* <p>Route 53 returns the domain name of the resource, such as www.example.com. Note the
|
|
402
|
+
* following:</p>
|
|
393
403
|
* <ul>
|
|
394
404
|
* <li>
|
|
395
|
-
* <p>You specify the domain name that you want to route traffic to when you register an
|
|
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>
|
|
405
|
+
* <p>You specify the domain name that you want to route traffic to when you register an
|
|
406
|
+
* instance. For more 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>
|
|
397
407
|
* </li>
|
|
398
408
|
* <li>
|
|
399
|
-
* <p>You must specify <code>WEIGHTED</code> for the value of
|
|
409
|
+
* <p>You must specify <code>WEIGHTED</code> for the value of
|
|
410
|
+
* <code>RoutingPolicy</code>.</p>
|
|
400
411
|
* </li>
|
|
401
412
|
* <li>
|
|
402
413
|
* <p>You can't specify both <code>CNAME</code> for <code>Type</code> and settings for
|
|
403
|
-
* <code>HealthCheckConfig</code>. If you do, the request will fail with an
|
|
404
|
-
*
|
|
414
|
+
* <code>HealthCheckConfig</code>. If you do, the request will fail with an
|
|
415
|
+
* <code>InvalidInput</code> error.</p>
|
|
405
416
|
* </li>
|
|
406
417
|
* </ul>
|
|
407
418
|
* </dd>
|
|
408
419
|
* <dt>SRV</dt>
|
|
409
420
|
* <dd>
|
|
410
|
-
* <p>Route 53 returns the value for an <code>SRV</code> record. The value for an <code>SRV</code>
|
|
411
|
-
* the following values:</p>
|
|
421
|
+
* <p>Route 53 returns the value for an <code>SRV</code> record. The value for an <code>SRV</code>
|
|
422
|
+
* record uses the following values:</p>
|
|
412
423
|
* <p>
|
|
413
424
|
* <code>priority weight port service-hostname</code>
|
|
414
425
|
* </p>
|
|
415
426
|
* <p>Note the following about the values:</p>
|
|
416
427
|
* <ul>
|
|
417
428
|
* <li>
|
|
418
|
-
* <p>The values of <code>priority</code> and <code>weight</code> are both set to
|
|
419
|
-
*
|
|
429
|
+
* <p>The values of <code>priority</code> and <code>weight</code> are both set to
|
|
430
|
+
* <code>1</code> and can't be changed. </p>
|
|
420
431
|
* </li>
|
|
421
432
|
* <li>
|
|
422
433
|
* <p>The value of <code>port</code> comes from the value that you specify for the
|
|
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>
|
|
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>
|
|
424
436
|
* </li>
|
|
425
437
|
* <li>
|
|
426
|
-
* <p>The value of <code>service-hostname</code> is a concatenation of the following
|
|
438
|
+
* <p>The value of <code>service-hostname</code> is a concatenation of the following
|
|
439
|
+
* values:</p>
|
|
427
440
|
* <ul>
|
|
428
441
|
* <li>
|
|
429
|
-
* <p>The value that you specify for <code>InstanceId</code> when you register an
|
|
442
|
+
* <p>The value that you specify for <code>InstanceId</code> when you register an
|
|
443
|
+
* instance.</p>
|
|
430
444
|
* </li>
|
|
431
445
|
* <li>
|
|
432
446
|
* <p>The name of the service.</p>
|
|
@@ -435,9 +449,10 @@ export interface DnsRecord {
|
|
|
435
449
|
* <p>The name of the namespace. </p>
|
|
436
450
|
* </li>
|
|
437
451
|
* </ul>
|
|
438
|
-
* <p>For example, if the value of <code>InstanceId</code> is <code>test</code>, the name of
|
|
439
|
-
*
|
|
440
|
-
* <code>service-hostname</code> is the
|
|
452
|
+
* <p>For example, if the value of <code>InstanceId</code> is <code>test</code>, the name of
|
|
453
|
+
* the service is <code>backend</code>, and the name of the namespace is
|
|
454
|
+
* <code>example.com</code>, the value of <code>service-hostname</code> is the
|
|
455
|
+
* following:</p>
|
|
441
456
|
* <p>
|
|
442
457
|
* <code>test.backend.example.com</code>
|
|
443
458
|
* </p>
|
|
@@ -446,16 +461,16 @@ export interface DnsRecord {
|
|
|
446
461
|
* <p>If you specify settings for an <code>SRV</code> record, note the following:</p>
|
|
447
462
|
* <ul>
|
|
448
463
|
* <li>
|
|
449
|
-
* <p>If you specify values for <code>AWS_INSTANCE_IPV4</code>,
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
464
|
+
* <p>If you specify values for <code>AWS_INSTANCE_IPV4</code>,
|
|
465
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both in the <code>RegisterInstance</code> request,
|
|
466
|
+
* Cloud Map automatically creates <code>A</code> and/or <code>AAAA</code> records that have
|
|
467
|
+
* the same name as the value of <code>service-hostname</code> in the <code>SRV</code> record.
|
|
468
|
+
* You can ignore these records.</p>
|
|
453
469
|
* </li>
|
|
454
470
|
* <li>
|
|
455
|
-
* <p>If you're using a system that requires a specific <code>SRV</code> format, such as
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
* format.</p>
|
|
471
|
+
* <p>If you're using a system that requires a specific <code>SRV</code> format, such as
|
|
472
|
+
* HAProxy, see the <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name">Name</a> element in the documentation about <code>CreateService</code> for information
|
|
473
|
+
* about how to specify the correct name format.</p>
|
|
459
474
|
* </li>
|
|
460
475
|
* </ul>
|
|
461
476
|
* </dd>
|
|
@@ -464,12 +479,14 @@ export interface DnsRecord {
|
|
|
464
479
|
*/
|
|
465
480
|
Type: RecordType | undefined;
|
|
466
481
|
/**
|
|
467
|
-
* <p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this
|
|
482
|
+
* <p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this
|
|
483
|
+
* record.</p>
|
|
468
484
|
* <note>
|
|
469
|
-
* <p>Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an
|
|
470
|
-
* routes traffic to. If you include the <code>AWS_ALIAS_DNS_NAME</code> attribute
|
|
471
|
-
*
|
|
472
|
-
*
|
|
485
|
+
* <p>Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an
|
|
486
|
+
* alias record routes traffic to. If you include the <code>AWS_ALIAS_DNS_NAME</code> attribute
|
|
487
|
+
* when you submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, the
|
|
488
|
+
* <code>TTL</code> value is ignored. Always specify a TTL for the service; you can use a service
|
|
489
|
+
* to register instances that create either alias or non-alias records.</p>
|
|
473
490
|
* </note>
|
|
474
491
|
* @public
|
|
475
492
|
*/
|
|
@@ -488,16 +505,15 @@ export declare const RoutingPolicy: {
|
|
|
488
505
|
*/
|
|
489
506
|
export type RoutingPolicy = (typeof RoutingPolicy)[keyof typeof RoutingPolicy];
|
|
490
507
|
/**
|
|
491
|
-
* <p>A complex type that contains information about the Amazon Route 53 DNS records that you want
|
|
492
|
-
* when you register an instance.</p>
|
|
508
|
+
* <p>A complex type that contains information about the Amazon Route 53 DNS records that you want
|
|
509
|
+
* Cloud Map to create when you register an instance.</p>
|
|
493
510
|
* @public
|
|
494
511
|
*/
|
|
495
512
|
export interface DnsConfig {
|
|
496
513
|
/**
|
|
497
514
|
* <p>
|
|
498
515
|
* <i>Use
|
|
499
|
-
* NamespaceId in <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html">Service</a>
|
|
500
|
-
* instead.</i>
|
|
516
|
+
* NamespaceId in <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html">Service</a> instead.</i>
|
|
501
517
|
* </p>
|
|
502
518
|
* <p>The ID of the namespace to use for DNS configuration.</p>
|
|
503
519
|
*
|
|
@@ -506,8 +522,8 @@ export interface DnsConfig {
|
|
|
506
522
|
*/
|
|
507
523
|
NamespaceId?: string | undefined;
|
|
508
524
|
/**
|
|
509
|
-
* <p>The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates
|
|
510
|
-
* register an instance and specify this service.</p>
|
|
525
|
+
* <p>The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates
|
|
526
|
+
* when you register an instance and specify this service.</p>
|
|
511
527
|
* <note>
|
|
512
528
|
* <p>If you want to use this service to register instances that create alias records, specify
|
|
513
529
|
* <code>WEIGHTED</code> for the routing policy.</p>
|
|
@@ -516,41 +532,44 @@ export interface DnsConfig {
|
|
|
516
532
|
* <dl>
|
|
517
533
|
* <dt>MULTIVALUE</dt>
|
|
518
534
|
* <dd>
|
|
519
|
-
* <p>If you define a health check for the service and the health check is healthy, Route 53
|
|
520
|
-
* applicable value for up to eight instances.</p>
|
|
521
|
-
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
522
|
-
* check. You use the service to register 10 instances. Route 53 responds to DNS
|
|
523
|
-
* to eight healthy instances. If fewer than eight instances are
|
|
524
|
-
* the IP addresses for all of the healthy
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
528
|
-
*
|
|
535
|
+
* <p>If you define a health check for the service and the health check is healthy, Route 53
|
|
536
|
+
* returns the applicable value for up to eight instances.</p>
|
|
537
|
+
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
538
|
+
* record and a health check. You use the service to register 10 instances. Route 53 responds to DNS
|
|
539
|
+
* queries with IP addresses for up to eight healthy instances. If fewer than eight instances are
|
|
540
|
+
* healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy
|
|
541
|
+
* instances.</p>
|
|
542
|
+
* <p>If you don't define a health check for the service, Route 53 assumes that all instances are
|
|
543
|
+
* healthy and returns the values for up to eight instances.</p>
|
|
544
|
+
* <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
|
|
545
|
+
* Answer Routing</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
529
546
|
* </dd>
|
|
530
547
|
* <dt>WEIGHTED</dt>
|
|
531
548
|
* <dd>
|
|
532
|
-
* <p>Route 53 returns the applicable value from one randomly selected instance from among the
|
|
533
|
-
* registered using the same service. Currently, all records have the same
|
|
534
|
-
* less traffic to any instances.</p>
|
|
535
|
-
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
536
|
-
* check. You use the service to register 10 instances. Route 53 responds to DNS
|
|
537
|
-
* one randomly selected instance from among the healthy
|
|
538
|
-
* to DNS queries as if all of the
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
*
|
|
549
|
+
* <p>Route 53 returns the applicable value from one randomly selected instance from among the
|
|
550
|
+
* instances that you registered using the same service. Currently, all records have the same
|
|
551
|
+
* weight, so you can't route more or less traffic to any instances.</p>
|
|
552
|
+
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
553
|
+
* record and a health check. You use the service to register 10 instances. Route 53 responds to DNS
|
|
554
|
+
* queries with the IP address for one randomly selected instance from among the healthy
|
|
555
|
+
* instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the
|
|
556
|
+
* instances were healthy.</p>
|
|
557
|
+
* <p>If you don't define a health check for the service, Route 53 assumes that all instances are
|
|
558
|
+
* healthy and returns the applicable value for one randomly selected instance.</p>
|
|
559
|
+
* <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
|
|
560
|
+
* Routing</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
543
561
|
* </dd>
|
|
544
562
|
* </dl>
|
|
545
563
|
* @public
|
|
546
564
|
*/
|
|
547
565
|
RoutingPolicy?: RoutingPolicy | undefined;
|
|
548
566
|
/**
|
|
549
|
-
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 DNS record that you
|
|
550
|
-
* to create when you register an instance.</p>
|
|
567
|
+
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 DNS record that you
|
|
568
|
+
* want Cloud Map to create when you register an instance.</p>
|
|
551
569
|
* <important>
|
|
552
|
-
* <p>The record type of a service specified in a <code>DnsRecord</code> object can't be updated.
|
|
553
|
-
*
|
|
570
|
+
* <p>The record type of a service specified in a <code>DnsRecord</code> object can't be updated.
|
|
571
|
+
* To change a record type, you need to delete the service and recreate it with a new
|
|
572
|
+
* <code>DnsConfig</code>.</p>
|
|
554
573
|
* </important>
|
|
555
574
|
* @public
|
|
556
575
|
*/
|
|
@@ -571,72 +590,73 @@ export declare const HealthCheckType: {
|
|
|
571
590
|
export type HealthCheckType = (typeof HealthCheckType)[keyof typeof HealthCheckType];
|
|
572
591
|
/**
|
|
573
592
|
* <p>
|
|
574
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
575
|
-
* optional health check. If you specify settings for a health check, Cloud Map
|
|
576
|
-
* the records that you specify in <code>DnsConfig</code>.</p>
|
|
593
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
594
|
+
* settings for an optional health check. If you specify settings for a health check, Cloud Map
|
|
595
|
+
* associates the health check with the records that you specify in <code>DnsConfig</code>.</p>
|
|
577
596
|
* <important>
|
|
578
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
579
|
-
*
|
|
597
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
598
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
580
599
|
* </important>
|
|
581
|
-
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For
|
|
582
|
-
* about pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53
|
|
583
|
-
* Pricing</a>.</p>
|
|
600
|
+
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For
|
|
601
|
+
* information about pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
|
|
584
602
|
* <p>Note the following about configuring health checks.</p>
|
|
585
603
|
* <dl>
|
|
586
604
|
* <dt>A and AAAA records</dt>
|
|
587
605
|
* <dd>
|
|
588
|
-
* <p>If <code>DnsConfig</code> includes configurations for both <code>A</code> and
|
|
589
|
-
*
|
|
590
|
-
* endpoint tthat's specified by the IPv4 address is
|
|
591
|
-
*
|
|
606
|
+
* <p>If <code>DnsConfig</code> includes configurations for both <code>A</code> and
|
|
607
|
+
* <code>AAAA</code> records, Cloud Map creates a health check that uses the IPv4 address to
|
|
608
|
+
* check the health of the resource. If the endpoint tthat's specified by the IPv4 address is
|
|
609
|
+
* unhealthy, Route 53 considers both the <code>A</code> and <code>AAAA</code> records to be
|
|
610
|
+
* unhealthy. </p>
|
|
592
611
|
* </dd>
|
|
593
612
|
* <dt>CNAME records</dt>
|
|
594
613
|
* <dd>
|
|
595
|
-
* <p>You can't specify settings for <code>HealthCheckConfig</code> when the
|
|
596
|
-
* <code>CNAME</code> for the value of <code>Type</code>. If you
|
|
597
|
-
* will fail with an <code>InvalidInput</code>
|
|
614
|
+
* <p>You can't specify settings for <code>HealthCheckConfig</code> when the
|
|
615
|
+
* <code>DNSConfig</code> includes <code>CNAME</code> for the value of <code>Type</code>. If you
|
|
616
|
+
* do, the <code>CreateService</code> request will fail with an <code>InvalidInput</code>
|
|
617
|
+
* error.</p>
|
|
598
618
|
* </dd>
|
|
599
619
|
* <dt>Request interval</dt>
|
|
600
620
|
* <dd>
|
|
601
|
-
* <p>A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request
|
|
602
|
-
* every 30 seconds. On average, your endpoint receives a health check request
|
|
603
|
-
* health checkers don't coordinate with one another.
|
|
604
|
-
* second that's followed by a few
|
|
621
|
+
* <p>A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request
|
|
622
|
+
* to an endpoint every 30 seconds. On average, your endpoint receives a health check request
|
|
623
|
+
* about every two seconds. However, health checkers don't coordinate with one another.
|
|
624
|
+
* Therefore, you might sometimes see several requests in one second that's followed by a few
|
|
625
|
+
* seconds with no health checks at all.</p>
|
|
605
626
|
* </dd>
|
|
606
627
|
* <dt>Health checking regions</dt>
|
|
607
628
|
* <dd>
|
|
608
|
-
* <p>Health checkers perform checks from all Route 53 health-checking Regions. For a list of the
|
|
609
|
-
* Regions, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions">Regions</a>.</p>
|
|
629
|
+
* <p>Health checkers perform checks from all Route 53 health-checking Regions. For a list of the
|
|
630
|
+
* current Regions, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions">Regions</a>.</p>
|
|
610
631
|
* </dd>
|
|
611
632
|
* <dt>Alias records</dt>
|
|
612
633
|
* <dd>
|
|
613
|
-
* <p>When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code>
|
|
614
|
-
* creates a Route 53 alias record. Note the following:</p>
|
|
634
|
+
* <p>When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code>
|
|
635
|
+
* attribute, Cloud Map creates a Route 53 alias record. Note the following:</p>
|
|
615
636
|
* <ul>
|
|
616
637
|
* <li>
|
|
617
|
-
* <p>Route 53 automatically sets <code>EvaluateTargetHealth</code> to true for alias records.
|
|
618
|
-
*
|
|
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>
|
|
638
|
+
* <p>Route 53 automatically sets <code>EvaluateTargetHealth</code> to true for alias records.
|
|
639
|
+
* When <code>EvaluateTargetHealth</code> is true, the alias record inherits the health of the
|
|
640
|
+
* referenced Amazon Web Services 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>
|
|
620
641
|
* </li>
|
|
621
642
|
* <li>
|
|
622
|
-
* <p>If you include <code>HealthCheckConfig</code> and then use the service to register an
|
|
623
|
-
* creates an alias record, Route 53 doesn't create the health check.</p>
|
|
643
|
+
* <p>If you include <code>HealthCheckConfig</code> and then use the service to register an
|
|
644
|
+
* instance that creates an alias record, Route 53 doesn't create the health check.</p>
|
|
624
645
|
* </li>
|
|
625
646
|
* </ul>
|
|
626
647
|
* </dd>
|
|
627
648
|
* <dt>Charges for health checks</dt>
|
|
628
649
|
* <dd>
|
|
629
|
-
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For
|
|
630
|
-
* pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53
|
|
631
|
-
* Pricing</a>.</p>
|
|
650
|
+
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For
|
|
651
|
+
* information about pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
|
|
632
652
|
* </dd>
|
|
633
653
|
* </dl>
|
|
634
654
|
* @public
|
|
635
655
|
*/
|
|
636
656
|
export interface HealthCheckConfig {
|
|
637
657
|
/**
|
|
638
|
-
* <p>The type of health check that you want to create, which indicates how Route 53 determines
|
|
639
|
-
* is healthy.</p>
|
|
658
|
+
* <p>The type of health check that you want to create, which indicates how Route 53 determines
|
|
659
|
+
* whether an endpoint is healthy.</p>
|
|
640
660
|
* <important>
|
|
641
661
|
* <p>You can't change the value of <code>Type</code> after you create a health check.</p>
|
|
642
662
|
* </important>
|
|
@@ -644,16 +664,18 @@ export interface HealthCheckConfig {
|
|
|
644
664
|
* <ul>
|
|
645
665
|
* <li>
|
|
646
666
|
* <p>
|
|
647
|
-
* <b>HTTP</b>: Route 53 tries to establish a TCP connection. If
|
|
648
|
-
* submits an HTTP request and waits for an HTTP status code of 200 or greater
|
|
667
|
+
* <b>HTTP</b>: Route 53 tries to establish a TCP connection. If
|
|
668
|
+
* successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater
|
|
669
|
+
* and less than 400.</p>
|
|
649
670
|
* </li>
|
|
650
671
|
* <li>
|
|
651
672
|
* <p>
|
|
652
|
-
* <b>HTTPS</b>: Route 53 tries to establish a TCP connection. If
|
|
653
|
-
* submits an HTTPS request and waits for an HTTP status code of 200 or greater
|
|
673
|
+
* <b>HTTPS</b>: Route 53 tries to establish a TCP connection. If
|
|
674
|
+
* successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater
|
|
675
|
+
* and less than 400.</p>
|
|
654
676
|
* <important>
|
|
655
|
-
* <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS
|
|
656
|
-
* later.</p>
|
|
677
|
+
* <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS
|
|
678
|
+
* v1.0 or later.</p>
|
|
657
679
|
* </important>
|
|
658
680
|
* </li>
|
|
659
681
|
* <li>
|
|
@@ -663,50 +685,57 @@ export interface HealthCheckConfig {
|
|
|
663
685
|
* <code>ResourcePath</code>.</p>
|
|
664
686
|
* </li>
|
|
665
687
|
* </ul>
|
|
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
|
|
667
|
-
* Whether an Endpoint Is Healthy</a> in the
|
|
688
|
+
* <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
|
|
689
|
+
* Determines Whether an Endpoint Is Healthy</a> in the
|
|
690
|
+
* <i>Route 53 Developer Guide</i>.</p>
|
|
668
691
|
* @public
|
|
669
692
|
*/
|
|
670
693
|
Type: HealthCheckType | undefined;
|
|
671
694
|
/**
|
|
672
|
-
* <p>The path that you want Route 53 to request when performing health checks. The path can be any
|
|
673
|
-
* endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint
|
|
674
|
-
*
|
|
675
|
-
* don't specify a value for <code>ResourcePath</code>,
|
|
676
|
-
*
|
|
677
|
-
*
|
|
695
|
+
* <p>The path that you want Route 53 to request when performing health checks. The path can be any
|
|
696
|
+
* value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint
|
|
697
|
+
* is healthy. An example file is <code>/docs/route53-health-check.html</code>. Route 53 automatically
|
|
698
|
+
* adds the DNS name for the service. If you don't specify a value for <code>ResourcePath</code>,
|
|
699
|
+
* the default value is <code>/</code>.</p>
|
|
700
|
+
* <p>If you specify <code>TCP</code> for <code>Type</code>, you must <i>not</i>
|
|
701
|
+
* specify a value for <code>ResourcePath</code>.</p>
|
|
678
702
|
* @public
|
|
679
703
|
*/
|
|
680
704
|
ResourcePath?: string | undefined;
|
|
681
705
|
/**
|
|
682
|
-
* <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to
|
|
683
|
-
* status of the endpoint from unhealthy to healthy or the other way around. For
|
|
684
|
-
*
|
|
706
|
+
* <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to
|
|
707
|
+
* change the current status of the endpoint from unhealthy to healthy or the other way around. For
|
|
708
|
+
* more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53
|
|
709
|
+
* Determines Whether an Endpoint Is Healthy</a> in the
|
|
710
|
+
* <i>Route 53 Developer Guide</i>.</p>
|
|
685
711
|
* @public
|
|
686
712
|
*/
|
|
687
713
|
FailureThreshold?: number | undefined;
|
|
688
714
|
}
|
|
689
715
|
/**
|
|
690
|
-
* <p>A complex type that contains information about an optional custom health check. A custom
|
|
691
|
-
* which requires that you use a third-party health checker to evaluate the health of
|
|
692
|
-
* the following circumstances:</p>
|
|
716
|
+
* <p>A complex type that contains information about an optional custom health check. A custom
|
|
717
|
+
* health check, which requires that you use a third-party health checker to evaluate the health of
|
|
718
|
+
* your resources, is useful in the following circumstances:</p>
|
|
693
719
|
* <ul>
|
|
694
720
|
* <li>
|
|
695
|
-
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
696
|
-
* available over the internet. For example, you can use a custom health check when
|
|
697
|
-
* VPC. (To check the health of resources in a VPC, the health
|
|
721
|
+
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
722
|
+
* resource isn't available over the internet. For example, you can use a custom health check when
|
|
723
|
+
* the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health
|
|
724
|
+
* checker must also be in the VPC.)</p>
|
|
698
725
|
* </li>
|
|
699
726
|
* <li>
|
|
700
|
-
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
727
|
+
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
728
|
+
* located.</p>
|
|
701
729
|
* </li>
|
|
702
730
|
* </ul>
|
|
703
731
|
* <important>
|
|
704
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
705
|
-
*
|
|
732
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
733
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
706
734
|
* </important>
|
|
707
|
-
* <p>To change the status of a custom health check, submit an
|
|
708
|
-
*
|
|
709
|
-
* the most recent
|
|
735
|
+
* <p>To change the status of a custom health check, submit an
|
|
736
|
+
* <code>UpdateInstanceCustomHealthStatus</code> request. Cloud Map doesn't monitor the status of the
|
|
737
|
+
* resource, it just keeps a record of the status specified in the most recent
|
|
738
|
+
* <code>UpdateInstanceCustomHealthStatus</code> request.</p>
|
|
710
739
|
* <p>Here's how custom health checks work:</p>
|
|
711
740
|
* <ol>
|
|
712
741
|
* <li>
|
|
@@ -716,8 +745,8 @@ export interface HealthCheckConfig {
|
|
|
716
745
|
* <p>You register an instance.</p>
|
|
717
746
|
* </li>
|
|
718
747
|
* <li>
|
|
719
|
-
* <p>You configure a third-party health checker to monitor the resource that's associated with
|
|
720
|
-
* instance. </p>
|
|
748
|
+
* <p>You configure a third-party health checker to monitor the resource that's associated with
|
|
749
|
+
* the new instance. </p>
|
|
721
750
|
* <note>
|
|
722
751
|
* <p>Cloud Map doesn't check the health of the resource directly. </p>
|
|
723
752
|
* </note>
|
|
@@ -733,8 +762,9 @@ export interface HealthCheckConfig {
|
|
|
733
762
|
* <p>Cloud Map waits for 30 seconds.</p>
|
|
734
763
|
* </li>
|
|
735
764
|
* <li>
|
|
736
|
-
* <p>If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during
|
|
737
|
-
* change the status back to healthy, Cloud Map stops routing traffic to the
|
|
765
|
+
* <p>If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during
|
|
766
|
+
* that time to change the status back to healthy, Cloud Map stops routing traffic to the
|
|
767
|
+
* resource.</p>
|
|
738
768
|
* </li>
|
|
739
769
|
* </ol>
|
|
740
770
|
* @public
|
|
@@ -742,16 +772,16 @@ export interface HealthCheckConfig {
|
|
|
742
772
|
export interface HealthCheckCustomConfig {
|
|
743
773
|
/**
|
|
744
774
|
* <important>
|
|
745
|
-
* <p>This parameter is no longer supported and is always set to 1. Cloud Map waits for
|
|
746
|
-
* after receiving an <code>UpdateInstanceCustomHealthStatus</code>
|
|
747
|
-
* service instance.</p>
|
|
775
|
+
* <p>This parameter is no longer supported and is always set to 1. Cloud Map waits for
|
|
776
|
+
* approximately 30 seconds after receiving an <code>UpdateInstanceCustomHealthStatus</code>
|
|
777
|
+
* request before changing the status of the service instance.</p>
|
|
748
778
|
* </important>
|
|
749
779
|
* <p>The number of 30-second intervals that you want Cloud Map to wait after receiving an
|
|
750
|
-
* <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a
|
|
751
|
-
* instance.</p>
|
|
752
|
-
* <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with
|
|
753
|
-
* before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits
|
|
754
|
-
*
|
|
780
|
+
* <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a
|
|
781
|
+
* service instance.</p>
|
|
782
|
+
* <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with
|
|
783
|
+
* the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits
|
|
784
|
+
* <code>30</code> seconds after the first request to make the change.</p>
|
|
755
785
|
*
|
|
756
786
|
* @deprecated
|
|
757
787
|
* @public
|
|
@@ -776,11 +806,12 @@ export interface CreateServiceRequest {
|
|
|
776
806
|
/**
|
|
777
807
|
* <p>The name that you want to assign to the service.</p>
|
|
778
808
|
* <note>
|
|
779
|
-
* <p>Do not include sensitive information in the name if the namespace is discoverable by public
|
|
780
|
-
* queries.</p>
|
|
809
|
+
* <p>Do not include sensitive information in the name if the namespace is discoverable by public
|
|
810
|
+
* DNS queries.</p>
|
|
781
811
|
* </note>
|
|
782
|
-
* <p>If you want Cloud Map to create an <code>SRV</code> record when you register an instance
|
|
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
|
|
812
|
+
* <p>If you want Cloud Map to create an <code>SRV</code> record when you register an instance
|
|
813
|
+
* and you're using a system that requires a specific <code>SRV</code> format, such as <a href="http://www.haproxy.org/">HAProxy</a>, specify the following for
|
|
814
|
+
* <code>Name</code>:</p>
|
|
784
815
|
* <ul>
|
|
785
816
|
* <li>
|
|
786
817
|
* <p>Start the name with an underscore (_), such as <code>_exampleservice</code>.</p>
|
|
@@ -789,29 +820,32 @@ export interface CreateServiceRequest {
|
|
|
789
820
|
* <p>End the name with <i>._protocol</i>, such as <code>._tcp</code>.</p>
|
|
790
821
|
* </li>
|
|
791
822
|
* </ul>
|
|
792
|
-
* <p>When you register an instance, Cloud Map creates an <code>SRV</code> record and assigns a
|
|
793
|
-
* record by concatenating the service name and the namespace name (for example,</p>
|
|
823
|
+
* <p>When you register an instance, Cloud Map creates an <code>SRV</code> record and assigns a
|
|
824
|
+
* name to the record by concatenating the service name and the namespace name (for example,</p>
|
|
794
825
|
* <p>
|
|
795
826
|
* <code>_exampleservice._tcp.example.com</code>).</p>
|
|
796
827
|
* <note>
|
|
797
|
-
* <p>For services that are accessible by DNS queries, you can't create multiple services with
|
|
798
|
-
* only by case (such as EXAMPLE and example). Otherwise, these services have the
|
|
799
|
-
* distinguished. However, if you use a namespace that's only accessible
|
|
800
|
-
* services that with names that differ only by case.</p>
|
|
828
|
+
* <p>For services that are accessible by DNS queries, you can't create multiple services with
|
|
829
|
+
* names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the
|
|
830
|
+
* same DNS name and can't be distinguished. However, if you use a namespace that's only accessible
|
|
831
|
+
* by API calls, then you can create services that with names that differ only by case.</p>
|
|
801
832
|
* </note>
|
|
802
833
|
* @public
|
|
803
834
|
*/
|
|
804
835
|
Name: string | undefined;
|
|
805
836
|
/**
|
|
806
|
-
* <p>The ID of the namespace that you want to use to create the service.
|
|
807
|
-
*
|
|
837
|
+
* <p>The ID or Amazon Resource Name (ARN) of the namespace that you want to use to create the service. For
|
|
838
|
+
* namespaces shared with your Amazon Web Services account, specify the namespace ARN. For more information
|
|
839
|
+
* about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
840
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
808
841
|
* @public
|
|
809
842
|
*/
|
|
810
843
|
NamespaceId?: string | undefined;
|
|
811
844
|
/**
|
|
812
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
813
|
-
*
|
|
814
|
-
* string (for example, a
|
|
845
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
846
|
+
* <code>CreateService</code> requests to be retried without the risk of running the operation
|
|
847
|
+
* twice. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
848
|
+
* date/timestamp).</p>
|
|
815
849
|
* @public
|
|
816
850
|
*/
|
|
817
851
|
CreatorRequestId?: string | undefined;
|
|
@@ -821,19 +855,20 @@ export interface CreateServiceRequest {
|
|
|
821
855
|
*/
|
|
822
856
|
Description?: string | undefined;
|
|
823
857
|
/**
|
|
824
|
-
* <p>A complex type that contains information about the Amazon Route 53 records that you want
|
|
825
|
-
* when you register an instance. </p>
|
|
858
|
+
* <p>A complex type that contains information about the Amazon Route 53 records that you want
|
|
859
|
+
* Cloud Map to create when you register an instance. </p>
|
|
826
860
|
* @public
|
|
827
861
|
*/
|
|
828
862
|
DnsConfig?: DnsConfig | undefined;
|
|
829
863
|
/**
|
|
830
864
|
* <p>
|
|
831
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
832
|
-
* optional Route 53 health check. If you specify settings for a health check,
|
|
833
|
-
* with all the Route 53 DNS records that you specify in
|
|
865
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
866
|
+
* settings for an optional Route 53 health check. If you specify settings for a health check,
|
|
867
|
+
* Cloud Map associates the health check with all the Route 53 DNS records that you specify in
|
|
868
|
+
* <code>DnsConfig</code>.</p>
|
|
834
869
|
* <important>
|
|
835
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
836
|
-
*
|
|
870
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
871
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
837
872
|
* </important>
|
|
838
873
|
* <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/cloud-map/pricing/">Cloud Map Pricing</a>.</p>
|
|
839
874
|
* @public
|
|
@@ -842,25 +877,25 @@ export interface CreateServiceRequest {
|
|
|
842
877
|
/**
|
|
843
878
|
* <p>A complex type that contains information about an optional custom health check.</p>
|
|
844
879
|
* <important>
|
|
845
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
846
|
-
*
|
|
880
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
881
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
847
882
|
* </important>
|
|
848
|
-
* <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration from
|
|
849
|
-
* service.</p>
|
|
883
|
+
* <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration from
|
|
884
|
+
* an existing service.</p>
|
|
850
885
|
* @public
|
|
851
886
|
*/
|
|
852
887
|
HealthCheckCustomConfig?: HealthCheckCustomConfig | undefined;
|
|
853
888
|
/**
|
|
854
|
-
* <p>The tags to add to the service. Each tag consists of a key and an optional value that you
|
|
855
|
-
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
889
|
+
* <p>The tags to add to the service. Each tag consists of a key and an optional value that you
|
|
890
|
+
* define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
856
891
|
* characters in length.</p>
|
|
857
892
|
* @public
|
|
858
893
|
*/
|
|
859
894
|
Tags?: Tag[] | undefined;
|
|
860
895
|
/**
|
|
861
896
|
* <p>If present, specifies that the service instances are only discoverable using the
|
|
862
|
-
* <code>DiscoverInstances</code> API operation. No DNS records is registered for the service
|
|
863
|
-
* valid value is <code>HTTP</code>.</p>
|
|
897
|
+
* <code>DiscoverInstances</code> API operation. No DNS records is registered for the service
|
|
898
|
+
* instances. The only valid value is <code>HTTP</code>.</p>
|
|
864
899
|
* @public
|
|
865
900
|
*/
|
|
866
901
|
Type?: ServiceTypeOption | undefined;
|
|
@@ -893,6 +928,14 @@ export interface Service {
|
|
|
893
928
|
* @public
|
|
894
929
|
*/
|
|
895
930
|
Arn?: string | undefined;
|
|
931
|
+
/**
|
|
932
|
+
* <p>The ID of the Amazon Web Services account that created the namespace with which the service is associated.
|
|
933
|
+
* If this isn't your account ID, it is the ID of the account that shared the namespace with your
|
|
934
|
+
* account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map
|
|
935
|
+
* namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
ResourceOwner?: string | undefined;
|
|
896
939
|
/**
|
|
897
940
|
* <p>The name of the service.</p>
|
|
898
941
|
* @public
|
|
@@ -909,18 +952,18 @@ export interface Service {
|
|
|
909
952
|
*/
|
|
910
953
|
Description?: string | undefined;
|
|
911
954
|
/**
|
|
912
|
-
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
913
|
-
* associated with the service but that are deleted aren't included in the count. The
|
|
914
|
-
* pending registrations and deregistrations.</p>
|
|
955
|
+
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
956
|
+
* previously associated with the service but that are deleted aren't included in the count. The
|
|
957
|
+
* count might not reflect pending registrations and deregistrations.</p>
|
|
915
958
|
* @public
|
|
916
959
|
*/
|
|
917
960
|
InstanceCount?: number | undefined;
|
|
918
961
|
/**
|
|
919
|
-
* <p>A complex type that contains information about the Route 53 DNS records that you want
|
|
920
|
-
* when you register an instance.</p>
|
|
962
|
+
* <p>A complex type that contains information about the Route 53 DNS records that you want
|
|
963
|
+
* Cloud Map to create when you register an instance.</p>
|
|
921
964
|
* <important>
|
|
922
|
-
* <p>The record types of a service can only be changed by deleting the service and recreating it
|
|
923
|
-
*
|
|
965
|
+
* <p>The record types of a service can only be changed by deleting the service and recreating it
|
|
966
|
+
* with a new <code>Dnsconfig</code>.</p>
|
|
924
967
|
* </important>
|
|
925
968
|
* @public
|
|
926
969
|
*/
|
|
@@ -930,8 +973,8 @@ export interface Service {
|
|
|
930
973
|
* <dl>
|
|
931
974
|
* <dt>DNS_HTTP</dt>
|
|
932
975
|
* <dd>
|
|
933
|
-
* <p>The service instances can be discovered using either DNS queries or the
|
|
934
|
-
*
|
|
976
|
+
* <p>The service instances can be discovered using either DNS queries or the
|
|
977
|
+
* <code>DiscoverInstances</code> API operation.</p>
|
|
935
978
|
* </dd>
|
|
936
979
|
* <dt>HTTP</dt>
|
|
937
980
|
* <dd>
|
|
@@ -948,9 +991,9 @@ export interface Service {
|
|
|
948
991
|
Type?: ServiceType | undefined;
|
|
949
992
|
/**
|
|
950
993
|
* <p>
|
|
951
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
952
|
-
* optional health check. If you specify settings for a health check, Cloud Map
|
|
953
|
-
* the records that you specify in <code>DnsConfig</code>.</p>
|
|
994
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
995
|
+
* settings for an optional health check. If you specify settings for a health check, Cloud Map
|
|
996
|
+
* associates the health check with the records that you specify in <code>DnsConfig</code>.</p>
|
|
954
997
|
* <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
|
|
955
998
|
* @public
|
|
956
999
|
*/
|
|
@@ -958,26 +1001,34 @@ export interface Service {
|
|
|
958
1001
|
/**
|
|
959
1002
|
* <p>A complex type that contains information about an optional custom health check.</p>
|
|
960
1003
|
* <important>
|
|
961
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
962
|
-
*
|
|
1004
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
1005
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
963
1006
|
* </important>
|
|
964
1007
|
* @public
|
|
965
1008
|
*/
|
|
966
1009
|
HealthCheckCustomConfig?: HealthCheckCustomConfig | undefined;
|
|
967
1010
|
/**
|
|
968
|
-
* <p>The date and time that the service was created, in Unix format and Coordinated Universal
|
|
969
|
-
* value of <code>CreateDate</code> is accurate to milliseconds. For example, the
|
|
970
|
-
* represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1011
|
+
* <p>The date and time that the service was created, in Unix format and Coordinated Universal
|
|
1012
|
+
* Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the
|
|
1013
|
+
* value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
971
1014
|
* @public
|
|
972
1015
|
*/
|
|
973
1016
|
CreateDate?: Date | undefined;
|
|
974
1017
|
/**
|
|
975
|
-
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
976
|
-
* of running the operation twice. <code>CreatorRequestId</code> can be any unique
|
|
977
|
-
* date/timestamp).</p>
|
|
1018
|
+
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
1019
|
+
* without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique
|
|
1020
|
+
* string (for example, a date/timestamp).</p>
|
|
978
1021
|
* @public
|
|
979
1022
|
*/
|
|
980
1023
|
CreatorRequestId?: string | undefined;
|
|
1024
|
+
/**
|
|
1025
|
+
* <p>The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is
|
|
1026
|
+
* the ID of account of the namespace owner or of another account with which the namespace has been
|
|
1027
|
+
* shared. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map
|
|
1028
|
+
* namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
1029
|
+
* @public
|
|
1030
|
+
*/
|
|
1031
|
+
CreatedByAccount?: string | undefined;
|
|
981
1032
|
}
|
|
982
1033
|
/**
|
|
983
1034
|
* @public
|
|
@@ -1020,14 +1071,19 @@ export declare class ServiceAlreadyExists extends __BaseException {
|
|
|
1020
1071
|
* @public
|
|
1021
1072
|
*/
|
|
1022
1073
|
ServiceId?: string | undefined;
|
|
1074
|
+
/**
|
|
1075
|
+
* <p>The ARN of the existing service.</p>
|
|
1076
|
+
* @public
|
|
1077
|
+
*/
|
|
1078
|
+
ServiceArn?: string | undefined;
|
|
1023
1079
|
/**
|
|
1024
1080
|
* @internal
|
|
1025
1081
|
*/
|
|
1026
1082
|
constructor(opts: __ExceptionOptionType<ServiceAlreadyExists, __BaseException>);
|
|
1027
1083
|
}
|
|
1028
1084
|
/**
|
|
1029
|
-
* <p>The health check for the instance that's specified by <code>ServiceId</code> and
|
|
1030
|
-
*
|
|
1085
|
+
* <p>The health check for the instance that's specified by <code>ServiceId</code> and
|
|
1086
|
+
* <code>InstanceId</code> isn't a custom health check. </p>
|
|
1031
1087
|
* @public
|
|
1032
1088
|
*/
|
|
1033
1089
|
export declare class CustomHealthNotFound extends __BaseException {
|
|
@@ -1056,7 +1112,7 @@ export type CustomHealthStatus = (typeof CustomHealthStatus)[keyof typeof Custom
|
|
|
1056
1112
|
*/
|
|
1057
1113
|
export interface DeleteNamespaceRequest {
|
|
1058
1114
|
/**
|
|
1059
|
-
* <p>The ID of the namespace that you want to delete.</p>
|
|
1115
|
+
* <p>The ID or Amazon Resource Name (ARN) of the namespace that you want to delete.</p>
|
|
1060
1116
|
* @public
|
|
1061
1117
|
*/
|
|
1062
1118
|
Id: string | undefined;
|
|
@@ -1073,8 +1129,8 @@ export interface DeleteNamespaceResponse {
|
|
|
1073
1129
|
OperationId?: string | undefined;
|
|
1074
1130
|
}
|
|
1075
1131
|
/**
|
|
1076
|
-
* <p>The specified resource can't be deleted because it contains other resources. For example,
|
|
1077
|
-
* a service that contains any instances.</p>
|
|
1132
|
+
* <p>The specified resource can't be deleted because it contains other resources. For example,
|
|
1133
|
+
* you can't delete a service that contains any instances.</p>
|
|
1078
1134
|
* @public
|
|
1079
1135
|
*/
|
|
1080
1136
|
export declare class ResourceInUse extends __BaseException {
|
|
@@ -1091,7 +1147,10 @@ export declare class ResourceInUse extends __BaseException {
|
|
|
1091
1147
|
*/
|
|
1092
1148
|
export interface DeleteServiceRequest {
|
|
1093
1149
|
/**
|
|
1094
|
-
* <p>The ID of the service that you want to delete
|
|
1150
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that you want to delete. If the namespace associated with
|
|
1151
|
+
* the service is shared with your Amazon Web Services account, specify the service ARN. For more information
|
|
1152
|
+
* about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace
|
|
1153
|
+
* sharing</a>.</p>
|
|
1095
1154
|
* @public
|
|
1096
1155
|
*/
|
|
1097
1156
|
Id: string | undefined;
|
|
@@ -1119,7 +1178,10 @@ export declare class ServiceNotFound extends __BaseException {
|
|
|
1119
1178
|
*/
|
|
1120
1179
|
export interface DeleteServiceAttributesRequest {
|
|
1121
1180
|
/**
|
|
1122
|
-
* <p>The ID of the service from which the attributes will be deleted
|
|
1181
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service from which the attributes will be deleted. For services
|
|
1182
|
+
* created in a namespace shared with your Amazon Web Services account, specify the service ARN. For more
|
|
1183
|
+
* information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
1184
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1123
1185
|
* @public
|
|
1124
1186
|
*/
|
|
1125
1187
|
ServiceId: string | undefined;
|
|
@@ -1139,7 +1201,10 @@ export interface DeleteServiceAttributesResponse {
|
|
|
1139
1201
|
*/
|
|
1140
1202
|
export interface DeregisterInstanceRequest {
|
|
1141
1203
|
/**
|
|
1142
|
-
* <p>The ID of the service that the instance is associated with
|
|
1204
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. If the namespace
|
|
1205
|
+
* associated with the service is shared with your account, specify the service ARN. For more
|
|
1206
|
+
* information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
1207
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1143
1208
|
* @public
|
|
1144
1209
|
*/
|
|
1145
1210
|
ServiceId: string | undefined;
|
|
@@ -1161,8 +1226,8 @@ export interface DeregisterInstanceResponse {
|
|
|
1161
1226
|
OperationId?: string | undefined;
|
|
1162
1227
|
}
|
|
1163
1228
|
/**
|
|
1164
|
-
* <p>No instance exists with the specified ID, or the instance was recently registered, and
|
|
1165
|
-
* the instance hasn't propagated yet.</p>
|
|
1229
|
+
* <p>No instance exists with the specified ID, or the instance was recently registered, and
|
|
1230
|
+
* information about the instance hasn't propagated yet.</p>
|
|
1166
1231
|
* @public
|
|
1167
1232
|
*/
|
|
1168
1233
|
export declare class InstanceNotFound extends __BaseException {
|
|
@@ -1193,10 +1258,11 @@ export type HealthStatusFilter = (typeof HealthStatusFilter)[keyof typeof Health
|
|
|
1193
1258
|
*/
|
|
1194
1259
|
export interface DiscoverInstancesRequest {
|
|
1195
1260
|
/**
|
|
1196
|
-
* <p>The <code>HttpName</code> name of the namespace.
|
|
1197
|
-
* the <code>
|
|
1198
|
-
*
|
|
1199
|
-
* <code>
|
|
1261
|
+
* <p>The <code>HttpName</code> name of the namespace. The <code>HttpName</code> is
|
|
1262
|
+
* found in the <code>HttpProperties</code> member of the <code>Properties</code> member of the
|
|
1263
|
+
* namespace. In most cases, <code>Name</code> and <code>HttpName</code> match. However, if you
|
|
1264
|
+
* reuse <code>Name</code> for namespace creation, a generated hash is added to
|
|
1265
|
+
* <code>HttpName</code> to distinguish the two.</p>
|
|
1200
1266
|
* @public
|
|
1201
1267
|
*/
|
|
1202
1268
|
NamespaceName: string | undefined;
|
|
@@ -1207,28 +1273,30 @@ export interface DiscoverInstancesRequest {
|
|
|
1207
1273
|
ServiceName: string | undefined;
|
|
1208
1274
|
/**
|
|
1209
1275
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
1210
|
-
* <code>DiscoverInstances</code> request. If you don't specify a value for
|
|
1211
|
-
* returns up to 100 instances.</p>
|
|
1276
|
+
* <code>DiscoverInstances</code> request. If you don't specify a value for
|
|
1277
|
+
* <code>MaxResults</code>, Cloud Map returns up to 100 instances.</p>
|
|
1212
1278
|
* @public
|
|
1213
1279
|
*/
|
|
1214
1280
|
MaxResults?: number | undefined;
|
|
1215
1281
|
/**
|
|
1216
|
-
* <p>Filters to scope the results based on custom attributes for the instance (for example,
|
|
1217
|
-
* az=1a\}</code>). Only instances that match all the specified key-value pairs
|
|
1282
|
+
* <p>Filters to scope the results based on custom attributes for the instance (for example,
|
|
1283
|
+
* <code>\{version=v1, az=1a\}</code>). Only instances that match all the specified key-value pairs
|
|
1284
|
+
* are returned.</p>
|
|
1218
1285
|
* @public
|
|
1219
1286
|
*/
|
|
1220
1287
|
QueryParameters?: Record<string, string> | undefined;
|
|
1221
1288
|
/**
|
|
1222
|
-
* <p>Opportunistic filters to scope the results based on custom attributes. If there are
|
|
1223
|
-
* both the filters specified in both the <code>QueryParameters</code>
|
|
1224
|
-
*
|
|
1225
|
-
*
|
|
1289
|
+
* <p>Opportunistic filters to scope the results based on custom attributes. If there are
|
|
1290
|
+
* instances that match both the filters specified in both the <code>QueryParameters</code>
|
|
1291
|
+
* parameter and this parameter, all of these instances are returned. Otherwise, the filters are
|
|
1292
|
+
* ignored, and only instances that match the filters that are specified in the
|
|
1293
|
+
* <code>QueryParameters</code> parameter are returned.</p>
|
|
1226
1294
|
* @public
|
|
1227
1295
|
*/
|
|
1228
1296
|
OptionalParameters?: Record<string, string> | undefined;
|
|
1229
1297
|
/**
|
|
1230
|
-
* <p>The health status of the instances that you want to discover. This parameter is ignored for
|
|
1231
|
-
* don't have a health check configured, and
|
|
1298
|
+
* <p>The health status of the instances that you want to discover. This parameter is ignored for
|
|
1299
|
+
* services that don't have a health check configured, and
|
|
1232
1300
|
* all
|
|
1233
1301
|
* instances are returned.</p>
|
|
1234
1302
|
* <dl>
|
|
@@ -1246,13 +1314,19 @@ export interface DiscoverInstancesRequest {
|
|
|
1246
1314
|
* </dd>
|
|
1247
1315
|
* <dt>HEALTHY_OR_ELSE_ALL</dt>
|
|
1248
1316
|
* <dd>
|
|
1249
|
-
* <p>Returns healthy instances, unless none are reporting a healthy state. In that case,
|
|
1250
|
-
* instances. This is also called failing open.</p>
|
|
1317
|
+
* <p>Returns healthy instances, unless none are reporting a healthy state. In that case,
|
|
1318
|
+
* return all instances. This is also called failing open.</p>
|
|
1251
1319
|
* </dd>
|
|
1252
1320
|
* </dl>
|
|
1253
1321
|
* @public
|
|
1254
1322
|
*/
|
|
1255
1323
|
HealthStatus?: HealthStatusFilter | undefined;
|
|
1324
|
+
/**
|
|
1325
|
+
* <p>The ID of the Amazon Web Services account that owns the namespace associated with the instance, as specified in the namespace <code>ResourceOwner</code> field. For
|
|
1326
|
+
* instances associated with namespaces that are shared with your account, you must specify an <code>OwnerAccount</code>.</p>
|
|
1327
|
+
* @public
|
|
1328
|
+
*/
|
|
1329
|
+
OwnerAccount?: string | undefined;
|
|
1256
1330
|
}
|
|
1257
1331
|
/**
|
|
1258
1332
|
* @public
|
|
@@ -1268,8 +1342,9 @@ export declare const HealthStatus: {
|
|
|
1268
1342
|
*/
|
|
1269
1343
|
export type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];
|
|
1270
1344
|
/**
|
|
1271
|
-
* <p>In a response to a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a> request,
|
|
1272
|
-
*
|
|
1345
|
+
* <p>In a response to a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a> request,
|
|
1346
|
+
* <code>HttpInstanceSummary</code> contains information about one instance that matches the values
|
|
1347
|
+
* that you specified in the request.</p>
|
|
1273
1348
|
* @public
|
|
1274
1349
|
*/
|
|
1275
1350
|
export interface HttpInstanceSummary {
|
|
@@ -1279,13 +1354,9 @@ export interface HttpInstanceSummary {
|
|
|
1279
1354
|
*/
|
|
1280
1355
|
InstanceId?: string | undefined;
|
|
1281
1356
|
/**
|
|
1282
|
-
* <p>
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1285
|
-
* <code></code>
|
|
1286
|
-
* </p>
|
|
1287
|
-
* <p>The <code>HttpName</code> name of the namespace. It's found in the <code>HttpProperties</code> member of
|
|
1288
|
-
* the <code>Properties</code> member of the namespace.</p>
|
|
1357
|
+
* <p>The <code>HttpName</code> name of the namespace. It's found in the
|
|
1358
|
+
* <code>HttpProperties</code> member of the <code>Properties</code> member of the
|
|
1359
|
+
* namespace.</p>
|
|
1289
1360
|
* @public
|
|
1290
1361
|
*/
|
|
1291
1362
|
NamespaceName?: string | undefined;
|
|
@@ -1295,12 +1366,14 @@ export interface HttpInstanceSummary {
|
|
|
1295
1366
|
*/
|
|
1296
1367
|
ServiceName?: string | undefined;
|
|
1297
1368
|
/**
|
|
1298
|
-
* <p>If you configured health checking in the service, the current health status of the service
|
|
1369
|
+
* <p>If you configured health checking in the service, the current health status of the service
|
|
1370
|
+
* instance.</p>
|
|
1299
1371
|
* @public
|
|
1300
1372
|
*/
|
|
1301
1373
|
HealthStatus?: HealthStatus | undefined;
|
|
1302
1374
|
/**
|
|
1303
|
-
* <p>If you included any attributes when you registered the instance, the values of those
|
|
1375
|
+
* <p>If you included any attributes when you registered the instance, the values of those
|
|
1376
|
+
* attributes.</p>
|
|
1304
1377
|
* @public
|
|
1305
1378
|
*/
|
|
1306
1379
|
Attributes?: Record<string, string> | undefined;
|
|
@@ -1310,22 +1383,23 @@ export interface HttpInstanceSummary {
|
|
|
1310
1383
|
*/
|
|
1311
1384
|
export interface DiscoverInstancesResponse {
|
|
1312
1385
|
/**
|
|
1313
|
-
* <p>A complex type that contains one <code>HttpInstanceSummary</code> for each registered
|
|
1386
|
+
* <p>A complex type that contains one <code>HttpInstanceSummary</code> for each registered
|
|
1387
|
+
* instance.</p>
|
|
1314
1388
|
* @public
|
|
1315
1389
|
*/
|
|
1316
1390
|
Instances?: HttpInstanceSummary[] | undefined;
|
|
1317
1391
|
/**
|
|
1318
|
-
* <p>The increasing revision associated to the response Instances list. If a new instance is
|
|
1319
|
-
* deregistered, the <code>InstancesRevision</code> updates. The health status updates
|
|
1320
|
-
*
|
|
1392
|
+
* <p>The increasing revision associated to the response Instances list. If a new instance is
|
|
1393
|
+
* registered or deregistered, the <code>InstancesRevision</code> updates. The health status updates
|
|
1394
|
+
* don't update <code>InstancesRevision</code>.</p>
|
|
1321
1395
|
* @public
|
|
1322
1396
|
*/
|
|
1323
1397
|
InstancesRevision?: number | undefined;
|
|
1324
1398
|
}
|
|
1325
1399
|
/**
|
|
1326
|
-
* <p>The operation can't be completed because you've reached the quota for the number of
|
|
1327
|
-
* information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request
|
|
1328
|
-
*
|
|
1400
|
+
* <p>The operation can't be completed because you've reached the quota for the number of
|
|
1401
|
+
* requests. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling quota</a> in the
|
|
1402
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1329
1403
|
* @public
|
|
1330
1404
|
*/
|
|
1331
1405
|
export declare class RequestLimitExceeded extends __BaseException {
|
|
@@ -1342,8 +1416,9 @@ export declare class RequestLimitExceeded extends __BaseException {
|
|
|
1342
1416
|
*/
|
|
1343
1417
|
export interface DiscoverInstancesRevisionRequest {
|
|
1344
1418
|
/**
|
|
1345
|
-
* <p>The <code>HttpName</code> name of the namespace.
|
|
1346
|
-
* the <code>
|
|
1419
|
+
* <p>The <code>HttpName</code> name of the namespace. The <code>HttpName</code> is
|
|
1420
|
+
* found in the <code>HttpProperties</code> member of the <code>Properties</code> member of the
|
|
1421
|
+
* namespace.</p>
|
|
1347
1422
|
* @public
|
|
1348
1423
|
*/
|
|
1349
1424
|
NamespaceName: string | undefined;
|
|
@@ -1352,35 +1427,43 @@ export interface DiscoverInstancesRevisionRequest {
|
|
|
1352
1427
|
* @public
|
|
1353
1428
|
*/
|
|
1354
1429
|
ServiceName: string | undefined;
|
|
1430
|
+
/**
|
|
1431
|
+
* <p>The ID of the Amazon Web Services account that owns the namespace associated with the instance, as specified in the namespace <code>ResourceOwner</code> field. For
|
|
1432
|
+
* instances associated with namespaces that are shared with your account, you must specify an <code>OwnerAccount</code>. For more information about
|
|
1433
|
+
* shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
1434
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1435
|
+
* @public
|
|
1436
|
+
*/
|
|
1437
|
+
OwnerAccount?: string | undefined;
|
|
1355
1438
|
}
|
|
1356
1439
|
/**
|
|
1357
1440
|
* @public
|
|
1358
1441
|
*/
|
|
1359
1442
|
export interface DiscoverInstancesRevisionResponse {
|
|
1360
1443
|
/**
|
|
1361
|
-
* <p>The increasing revision associated to the response Instances list. If a new instance is
|
|
1362
|
-
* deregistered, the <code>InstancesRevision</code> updates. The health status updates
|
|
1363
|
-
*
|
|
1444
|
+
* <p>The increasing revision associated to the response Instances list. If a new instance is
|
|
1445
|
+
* registered or deregistered, the <code>InstancesRevision</code> updates. The health status updates
|
|
1446
|
+
* don't update <code>InstancesRevision</code>.</p>
|
|
1364
1447
|
* @public
|
|
1365
1448
|
*/
|
|
1366
1449
|
InstancesRevision?: number | undefined;
|
|
1367
1450
|
}
|
|
1368
1451
|
/**
|
|
1369
|
-
* <p>A complex type that contains information about changes to the Route 53 DNS records that
|
|
1370
|
-
* when you register an instance.</p>
|
|
1452
|
+
* <p>A complex type that contains information about changes to the Route 53 DNS records that
|
|
1453
|
+
* Cloud Map creates when you register an instance.</p>
|
|
1371
1454
|
* @public
|
|
1372
1455
|
*/
|
|
1373
1456
|
export interface DnsConfigChange {
|
|
1374
1457
|
/**
|
|
1375
|
-
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 record that you want
|
|
1376
|
-
* create when you register an instance.</p>
|
|
1458
|
+
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 record that you want
|
|
1459
|
+
* Cloud Map to create when you register an instance.</p>
|
|
1377
1460
|
* @public
|
|
1378
1461
|
*/
|
|
1379
1462
|
DnsRecords: DnsRecord[] | undefined;
|
|
1380
1463
|
}
|
|
1381
1464
|
/**
|
|
1382
|
-
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
|
|
1383
|
-
* namespace.</p>
|
|
1465
|
+
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
|
|
1466
|
+
* you create a namespace.</p>
|
|
1384
1467
|
* @public
|
|
1385
1468
|
*/
|
|
1386
1469
|
export interface DnsProperties {
|
|
@@ -1414,7 +1497,10 @@ export type FilterCondition = (typeof FilterCondition)[keyof typeof FilterCondit
|
|
|
1414
1497
|
*/
|
|
1415
1498
|
export interface GetInstanceRequest {
|
|
1416
1499
|
/**
|
|
1417
|
-
* <p>The ID of the service that the instance is associated with
|
|
1500
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. For services
|
|
1501
|
+
* created in a shared namespace, specify the service ARN. For more information about shared
|
|
1502
|
+
* namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
1503
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1418
1504
|
* @public
|
|
1419
1505
|
*/
|
|
1420
1506
|
ServiceId: string | undefined;
|
|
@@ -1425,8 +1511,8 @@ export interface GetInstanceRequest {
|
|
|
1425
1511
|
InstanceId: string | undefined;
|
|
1426
1512
|
}
|
|
1427
1513
|
/**
|
|
1428
|
-
* <p>A complex type that contains information about an instance that Cloud Map creates when you
|
|
1429
|
-
*
|
|
1514
|
+
* <p>A complex type that contains information about an instance that Cloud Map creates when you
|
|
1515
|
+
* submit a <code>RegisterInstance</code> request.</p>
|
|
1430
1516
|
* @public
|
|
1431
1517
|
*/
|
|
1432
1518
|
export interface Instance {
|
|
@@ -1434,24 +1520,25 @@ export interface Instance {
|
|
|
1434
1520
|
* <p>An identifier that you want to associate with the instance. Note the following:</p>
|
|
1435
1521
|
* <ul>
|
|
1436
1522
|
* <li>
|
|
1437
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
1438
|
-
*
|
|
1439
|
-
*
|
|
1523
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
1524
|
+
* <code>SRV</code> record, the value of <code>InstanceId</code> is automatically included as
|
|
1525
|
+
* part of the value for the <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 >
|
|
1526
|
+
* Type</a>.</p>
|
|
1440
1527
|
* </li>
|
|
1441
1528
|
* <li>
|
|
1442
1529
|
* <p>You can use this value to update an existing instance.</p>
|
|
1443
1530
|
* </li>
|
|
1444
1531
|
* <li>
|
|
1445
|
-
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
1446
|
-
* using the same service. </p>
|
|
1532
|
+
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
1533
|
+
* you register by using the same service. </p>
|
|
1447
1534
|
* </li>
|
|
1448
1535
|
* <li>
|
|
1449
|
-
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
1450
|
-
* existing DNS records. If there's also an existing health check, Cloud Map deletes
|
|
1451
|
-
* creates a new one. </p>
|
|
1536
|
+
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
1537
|
+
* updates the existing DNS records. If there's also an existing health check, Cloud Map deletes
|
|
1538
|
+
* the old health check and creates a new one. </p>
|
|
1452
1539
|
* <note>
|
|
1453
|
-
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
1454
|
-
*
|
|
1540
|
+
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
1541
|
+
* submit a <code>ListHealthChecks</code> request, for example.</p>
|
|
1455
1542
|
* </note>
|
|
1456
1543
|
* </li>
|
|
1457
1544
|
* </ul>
|
|
@@ -1459,11 +1546,12 @@ export interface Instance {
|
|
|
1459
1546
|
*/
|
|
1460
1547
|
Id: string | undefined;
|
|
1461
1548
|
/**
|
|
1462
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
1463
|
-
*
|
|
1464
|
-
*
|
|
1465
|
-
*
|
|
1466
|
-
* unique string (for example, a
|
|
1549
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
1550
|
+
* <code>RegisterInstance</code> requests to be retried without the risk of executing the operation
|
|
1551
|
+
* twice. You must use a unique <code>CreatorRequestId</code> string every time you submit a
|
|
1552
|
+
* <code>RegisterInstance</code> request if you're registering additional instances for the same
|
|
1553
|
+
* namespace and service. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
1554
|
+
* date/time stamp).</p>
|
|
1467
1555
|
* @public
|
|
1468
1556
|
*/
|
|
1469
1557
|
CreatorRequestId?: string | undefined;
|
|
@@ -1479,38 +1567,38 @@ export interface Instance {
|
|
|
1479
1567
|
* </li>
|
|
1480
1568
|
* </ul>
|
|
1481
1569
|
* <note>
|
|
1482
|
-
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by
|
|
1483
|
-
* queries.</p>
|
|
1570
|
+
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by
|
|
1571
|
+
* public DNS queries.</p>
|
|
1484
1572
|
* </note>
|
|
1485
1573
|
* <p>Supported attribute keys include the following:</p>
|
|
1486
1574
|
* <dl>
|
|
1487
1575
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
1488
1576
|
* <dd>
|
|
1489
|
-
* <p>If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing
|
|
1490
|
-
* specify the DNS name that's associated with the load balancer. For information
|
|
1491
|
-
* 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>
|
|
1577
|
+
* <p>If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing
|
|
1578
|
+
* load balancer, specify the DNS name that's associated with the load balancer. For information
|
|
1579
|
+
* about how to get the DNS name, 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>
|
|
1492
1580
|
* <p>Note the following:</p>
|
|
1493
1581
|
* <ul>
|
|
1494
1582
|
* <li>
|
|
1495
|
-
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
1496
|
-
* an <code>A</code> record, an <code>AAAA</code> record, or both.</p>
|
|
1583
|
+
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
1584
|
+
* include settings for an <code>A</code> record, an <code>AAAA</code> record, or both.</p>
|
|
1497
1585
|
* </li>
|
|
1498
1586
|
* <li>
|
|
1499
|
-
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
1500
|
-
*
|
|
1587
|
+
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
1588
|
+
* <code>RoutingPolicy</code> must be <code>WEIGHTED</code>.</p>
|
|
1501
1589
|
* </li>
|
|
1502
1590
|
* <li>
|
|
1503
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
1504
|
-
*
|
|
1505
|
-
* record.</p>
|
|
1591
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
1592
|
+
* <code>HealthCheckConfig</code> settings, Cloud Map creates the health check, but it won't
|
|
1593
|
+
* associate the health check with the alias record.</p>
|
|
1506
1594
|
* </li>
|
|
1507
1595
|
* <li>
|
|
1508
|
-
* <p>Auto naming currently doesn't support creating alias records that route traffic to
|
|
1509
|
-
* other than ELB load balancers.</p>
|
|
1596
|
+
* <p>Auto naming currently doesn't support creating alias records that route traffic to
|
|
1597
|
+
* Amazon Web Services resources other than ELB load balancers.</p>
|
|
1510
1598
|
* </li>
|
|
1511
1599
|
* <li>
|
|
1512
|
-
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
1513
|
-
*
|
|
1600
|
+
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
1601
|
+
* any of the <code>AWS_INSTANCE</code> attributes.</p>
|
|
1514
1602
|
* </li>
|
|
1515
1603
|
* </ul>
|
|
1516
1604
|
* </dd>
|
|
@@ -1522,53 +1610,72 @@ export interface Instance {
|
|
|
1522
1610
|
* </dd>
|
|
1523
1611
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
1524
1612
|
* <dd>
|
|
1525
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
1526
|
-
*
|
|
1527
|
-
*
|
|
1613
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
1614
|
+
* optionally use <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom
|
|
1615
|
+
* health check, <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
1528
1616
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
1529
1617
|
* </dd>
|
|
1530
1618
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
1531
1619
|
* <dd>
|
|
1532
|
-
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
1533
|
-
* to return in response to DNS queries (for example,
|
|
1534
|
-
*
|
|
1535
|
-
*
|
|
1620
|
+
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
1621
|
+
* you want Route 53 to return in response to DNS queries (for example,
|
|
1622
|
+
* <code>example.com</code>).</p>
|
|
1623
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1624
|
+
* settings for an <code>CNAME</code> record.</p>
|
|
1536
1625
|
* </dd>
|
|
1537
1626
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
1538
1627
|
* <dd>
|
|
1539
|
-
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
1540
|
-
* return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
1541
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1542
|
-
*
|
|
1543
|
-
*
|
|
1628
|
+
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
1629
|
+
* want Route 53 to return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
1630
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1631
|
+
* settings for an <code>A</code> record. If the service includes settings for an
|
|
1632
|
+
* <code>SRV</code> record, you must specify a value for <code>AWS_INSTANCE_IPV4</code>,
|
|
1633
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
1544
1634
|
* </dd>
|
|
1545
1635
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
1546
1636
|
* <dd>
|
|
1547
|
-
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
1548
|
-
* to return in response to DNS queries (for example,
|
|
1549
|
-
*
|
|
1550
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1551
|
-
*
|
|
1552
|
-
*
|
|
1637
|
+
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
1638
|
+
* you want Route 53 to return in response to DNS queries (for example,
|
|
1639
|
+
* <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
1640
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1641
|
+
* settings for an <code>AAAA</code> record. If the service includes settings for an
|
|
1642
|
+
* <code>SRV</code> record, you must specify a value for <code>AWS_INSTANCE_IPV4</code>,
|
|
1643
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
1553
1644
|
* </dd>
|
|
1554
1645
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
1555
1646
|
* <dd>
|
|
1556
|
-
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to
|
|
1557
|
-
* port.</p>
|
|
1558
|
-
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
1559
|
-
* send requests to. </p>
|
|
1560
|
-
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
1561
|
-
* when you created the service.</p>
|
|
1647
|
+
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to
|
|
1648
|
+
* return for the port.</p>
|
|
1649
|
+
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
1650
|
+
* want Route 53 to send requests to. </p>
|
|
1651
|
+
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
1652
|
+
* Route 53 health check when you created the service.</p>
|
|
1562
1653
|
* </dd>
|
|
1563
1654
|
* </dl>
|
|
1564
1655
|
* @public
|
|
1565
1656
|
*/
|
|
1566
1657
|
Attributes?: Record<string, string> | undefined;
|
|
1658
|
+
/**
|
|
1659
|
+
* <p>The ID of the Amazon Web Services account that registered the instance. If this isn't your account ID,
|
|
1660
|
+
* it's the ID of the account that shared the namespace with your account or the ID of another
|
|
1661
|
+
* account with which the namespace has been shared. For more information about shared namespaces,
|
|
1662
|
+
* see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account
|
|
1663
|
+
* Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
1664
|
+
* @public
|
|
1665
|
+
*/
|
|
1666
|
+
CreatedByAccount?: string | undefined;
|
|
1567
1667
|
}
|
|
1568
1668
|
/**
|
|
1569
1669
|
* @public
|
|
1570
1670
|
*/
|
|
1571
1671
|
export interface GetInstanceResponse {
|
|
1672
|
+
/**
|
|
1673
|
+
* <p>The ID of the Amazon Web Services account that created the namespace that contains the service that the
|
|
1674
|
+
* instance is associated with. If this isn't your account ID, it's the ID of the account that
|
|
1675
|
+
* shared the namespace with your account.</p>
|
|
1676
|
+
* @public
|
|
1677
|
+
*/
|
|
1678
|
+
ResourceOwner?: string | undefined;
|
|
1572
1679
|
/**
|
|
1573
1680
|
* <p>A complex type that contains information about a specified instance.</p>
|
|
1574
1681
|
* @public
|
|
@@ -1580,32 +1687,37 @@ export interface GetInstanceResponse {
|
|
|
1580
1687
|
*/
|
|
1581
1688
|
export interface GetInstancesHealthStatusRequest {
|
|
1582
1689
|
/**
|
|
1583
|
-
* <p>The ID of the service that the instance is associated with
|
|
1690
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. For services
|
|
1691
|
+
* created in a shared namespace, specify the service ARN. For more information about shared
|
|
1692
|
+
* namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
1693
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1584
1694
|
* @public
|
|
1585
1695
|
*/
|
|
1586
1696
|
ServiceId: string | undefined;
|
|
1587
1697
|
/**
|
|
1588
|
-
* <p>An array that contains the IDs of all the instances that you want to get the health status
|
|
1589
|
-
*
|
|
1590
|
-
*
|
|
1698
|
+
* <p>An array that contains the IDs of all the instances that you want to get the health status
|
|
1699
|
+
* for.</p>
|
|
1700
|
+
* <p>If you omit <code>Instances</code>, Cloud Map returns the health status for all the
|
|
1701
|
+
* instances that are associated with the specified service.</p>
|
|
1591
1702
|
* <note>
|
|
1592
|
-
* <p>To get the IDs for the instances that you've registered by using a specified service,
|
|
1703
|
+
* <p>To get the IDs for the instances that you've registered by using a specified service,
|
|
1704
|
+
* submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html">ListInstances</a> request.</p>
|
|
1593
1705
|
* </note>
|
|
1594
1706
|
* @public
|
|
1595
1707
|
*/
|
|
1596
1708
|
Instances?: string[] | undefined;
|
|
1597
1709
|
/**
|
|
1598
1710
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
1599
|
-
* <code>GetInstancesHealthStatus</code> request. If you don't specify a value for
|
|
1600
|
-
*
|
|
1711
|
+
* <code>GetInstancesHealthStatus</code> request. If you don't specify a value for
|
|
1712
|
+
* <code>MaxResults</code>, Cloud Map returns up to 100 instances.</p>
|
|
1601
1713
|
* @public
|
|
1602
1714
|
*/
|
|
1603
1715
|
MaxResults?: number | undefined;
|
|
1604
1716
|
/**
|
|
1605
1717
|
* <p>For the first <code>GetInstancesHealthStatus</code> request, omit this value.</p>
|
|
1606
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1607
|
-
*
|
|
1608
|
-
*
|
|
1718
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1719
|
+
* another <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify
|
|
1720
|
+
* the value of <code>NextToken</code> from the previous response in the next request.</p>
|
|
1609
1721
|
* @public
|
|
1610
1722
|
*/
|
|
1611
1723
|
NextToken?: string | undefined;
|
|
@@ -1615,15 +1727,15 @@ export interface GetInstancesHealthStatusRequest {
|
|
|
1615
1727
|
*/
|
|
1616
1728
|
export interface GetInstancesHealthStatusResponse {
|
|
1617
1729
|
/**
|
|
1618
|
-
* <p>A complex type that contains the IDs and the health status of the instances that you
|
|
1619
|
-
*
|
|
1730
|
+
* <p>A complex type that contains the IDs and the health status of the instances that you
|
|
1731
|
+
* specified in the <code>GetInstancesHealthStatus</code> request.</p>
|
|
1620
1732
|
* @public
|
|
1621
1733
|
*/
|
|
1622
1734
|
Status?: Record<string, HealthStatus> | undefined;
|
|
1623
1735
|
/**
|
|
1624
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1625
|
-
*
|
|
1626
|
-
*
|
|
1736
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1737
|
+
* another <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify
|
|
1738
|
+
* the value of <code>NextToken</code> from the previous response in the next request.</p>
|
|
1627
1739
|
* @public
|
|
1628
1740
|
*/
|
|
1629
1741
|
NextToken?: string | undefined;
|
|
@@ -1633,7 +1745,11 @@ export interface GetInstancesHealthStatusResponse {
|
|
|
1633
1745
|
*/
|
|
1634
1746
|
export interface GetNamespaceRequest {
|
|
1635
1747
|
/**
|
|
1636
|
-
* <p>The ID of the namespace that you want to get information about
|
|
1748
|
+
* <p>The ID or Amazon Resource Name (ARN) of the namespace that you want to get information about. For namespaces
|
|
1749
|
+
* shared with your Amazon Web Services account, specify the namespace ARN. For more information about shared
|
|
1750
|
+
* namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
1751
|
+
* <i>Cloud Map Developer Guide</i>
|
|
1752
|
+
* </p>
|
|
1637
1753
|
* @public
|
|
1638
1754
|
*/
|
|
1639
1755
|
Id: string | undefined;
|
|
@@ -1655,8 +1771,8 @@ export interface HttpProperties {
|
|
|
1655
1771
|
*/
|
|
1656
1772
|
export interface NamespaceProperties {
|
|
1657
1773
|
/**
|
|
1658
|
-
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
|
|
1659
|
-
* namespace.</p>
|
|
1774
|
+
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
|
|
1775
|
+
* you create a namespace.</p>
|
|
1660
1776
|
* @public
|
|
1661
1777
|
*/
|
|
1662
1778
|
DnsProperties?: DnsProperties | undefined;
|
|
@@ -1694,29 +1810,37 @@ export interface Namespace {
|
|
|
1694
1810
|
* @public
|
|
1695
1811
|
*/
|
|
1696
1812
|
Arn?: string | undefined;
|
|
1813
|
+
/**
|
|
1814
|
+
* <p>The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's
|
|
1815
|
+
* the ID of the account that shared the namespace with your account. For more information about
|
|
1816
|
+
* shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
1817
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1818
|
+
* @public
|
|
1819
|
+
*/
|
|
1820
|
+
ResourceOwner?: string | undefined;
|
|
1697
1821
|
/**
|
|
1698
1822
|
* <p>The name of the namespace, such as <code>example.com</code>.</p>
|
|
1699
1823
|
* @public
|
|
1700
1824
|
*/
|
|
1701
1825
|
Name?: string | undefined;
|
|
1702
1826
|
/**
|
|
1703
|
-
* <p>The type of the namespace. The methods for discovering instances depends on the value that
|
|
1704
|
-
* specify:</p>
|
|
1827
|
+
* <p>The type of the namespace. The methods for discovering instances depends on the value that
|
|
1828
|
+
* you specify:</p>
|
|
1705
1829
|
* <dl>
|
|
1706
1830
|
* <dt>HTTP</dt>
|
|
1707
1831
|
* <dd>
|
|
1708
|
-
* <p>Instances can be discovered only programmatically, using the Cloud Map
|
|
1709
|
-
*
|
|
1832
|
+
* <p>Instances can be discovered only programmatically, using the Cloud Map
|
|
1833
|
+
* <code>DiscoverInstances</code> API.</p>
|
|
1710
1834
|
* </dd>
|
|
1711
1835
|
* <dt>DNS_PUBLIC</dt>
|
|
1712
1836
|
* <dd>
|
|
1713
|
-
* <p>Instances can be discovered using public DNS queries and using the
|
|
1714
|
-
*
|
|
1837
|
+
* <p>Instances can be discovered using public DNS queries and using the
|
|
1838
|
+
* <code>DiscoverInstances</code> API.</p>
|
|
1715
1839
|
* </dd>
|
|
1716
1840
|
* <dt>DNS_PRIVATE</dt>
|
|
1717
1841
|
* <dd>
|
|
1718
|
-
* <p>Instances can be discovered using DNS queries in VPCs and using the
|
|
1719
|
-
*
|
|
1842
|
+
* <p>Instances can be discovered using DNS queries in VPCs and using the
|
|
1843
|
+
* <code>DiscoverInstances</code> API.</p>
|
|
1720
1844
|
* </dd>
|
|
1721
1845
|
* </dl>
|
|
1722
1846
|
* @public
|
|
@@ -1733,20 +1857,21 @@ export interface Namespace {
|
|
|
1733
1857
|
*/
|
|
1734
1858
|
ServiceCount?: number | undefined;
|
|
1735
1859
|
/**
|
|
1736
|
-
* <p>A complex type that contains information that's specific to the type of the
|
|
1860
|
+
* <p>A complex type that contains information that's specific to the type of the
|
|
1861
|
+
* namespace.</p>
|
|
1737
1862
|
* @public
|
|
1738
1863
|
*/
|
|
1739
1864
|
Properties?: NamespaceProperties | undefined;
|
|
1740
1865
|
/**
|
|
1741
|
-
* <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal
|
|
1742
|
-
* value of <code>CreateDate</code> is accurate to milliseconds. For example, the
|
|
1743
|
-
* represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1866
|
+
* <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal
|
|
1867
|
+
* Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the
|
|
1868
|
+
* value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1744
1869
|
* @public
|
|
1745
1870
|
*/
|
|
1746
1871
|
CreateDate?: Date | undefined;
|
|
1747
1872
|
/**
|
|
1748
|
-
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
1749
|
-
* of running an operation twice. </p>
|
|
1873
|
+
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
1874
|
+
* without the risk of running an operation twice. </p>
|
|
1750
1875
|
* @public
|
|
1751
1876
|
*/
|
|
1752
1877
|
CreatorRequestId?: string | undefined;
|
|
@@ -1770,6 +1895,12 @@ export interface GetOperationRequest {
|
|
|
1770
1895
|
* @public
|
|
1771
1896
|
*/
|
|
1772
1897
|
OperationId: string | undefined;
|
|
1898
|
+
/**
|
|
1899
|
+
* <p>The ID of the Amazon Web Services account that owns the namespace associated with the operation, as specified in the namespace <code>ResourceOwner</code> field. For
|
|
1900
|
+
* operations associated with namespaces that are shared with your account, you must specify an <code>OwnerAccount</code>.</p>
|
|
1901
|
+
* @public
|
|
1902
|
+
*/
|
|
1903
|
+
OwnerAccount?: string | undefined;
|
|
1773
1904
|
}
|
|
1774
1905
|
/**
|
|
1775
1906
|
* @public
|
|
@@ -1824,6 +1955,11 @@ export interface Operation {
|
|
|
1824
1955
|
* @public
|
|
1825
1956
|
*/
|
|
1826
1957
|
Id?: string | undefined;
|
|
1958
|
+
/**
|
|
1959
|
+
* <p>The ID of the Amazon Web Services account that owns the namespace associated with the operation.</p>
|
|
1960
|
+
* @public
|
|
1961
|
+
*/
|
|
1962
|
+
OwnerAccount?: string | undefined;
|
|
1827
1963
|
/**
|
|
1828
1964
|
* <p>The name of the operation that's associated with the specified ID.</p>
|
|
1829
1965
|
* @public
|
|
@@ -1853,13 +1989,14 @@ export interface Operation {
|
|
|
1853
1989
|
*/
|
|
1854
1990
|
Status?: OperationStatus | undefined;
|
|
1855
1991
|
/**
|
|
1856
|
-
* <p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation
|
|
1992
|
+
* <p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation
|
|
1993
|
+
* failed.</p>
|
|
1857
1994
|
* @public
|
|
1858
1995
|
*/
|
|
1859
1996
|
ErrorMessage?: string | undefined;
|
|
1860
1997
|
/**
|
|
1861
|
-
* <p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code>
|
|
1862
|
-
* following:</p>
|
|
1998
|
+
* <p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code>
|
|
1999
|
+
* include the following:</p>
|
|
1863
2000
|
* <ul>
|
|
1864
2001
|
* <li>
|
|
1865
2002
|
* <p>
|
|
@@ -1901,16 +2038,18 @@ export interface Operation {
|
|
|
1901
2038
|
*/
|
|
1902
2039
|
ErrorCode?: string | undefined;
|
|
1903
2040
|
/**
|
|
1904
|
-
* <p>The date and time that the request was submitted, in Unix date/time format and Coordinated
|
|
1905
|
-
* (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For
|
|
1906
|
-
*
|
|
2041
|
+
* <p>The date and time that the request was submitted, in Unix date/time format and Coordinated
|
|
2042
|
+
* Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For
|
|
2043
|
+
* example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087
|
|
2044
|
+
* AM.</p>
|
|
1907
2045
|
* @public
|
|
1908
2046
|
*/
|
|
1909
2047
|
CreateDate?: Date | undefined;
|
|
1910
2048
|
/**
|
|
1911
|
-
* <p>The date and time that the value of <code>Status</code> changed to the current value, in
|
|
1912
|
-
* format and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code>
|
|
1913
|
-
* For example, the value <code>1516925490.087</code> represents
|
|
2049
|
+
* <p>The date and time that the value of <code>Status</code> changed to the current value, in
|
|
2050
|
+
* Unix date/time format and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code>
|
|
2051
|
+
* is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents
|
|
2052
|
+
* Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1914
2053
|
* @public
|
|
1915
2054
|
*/
|
|
1916
2055
|
UpdateDate?: Date | undefined;
|
|
@@ -1962,7 +2101,10 @@ export declare class OperationNotFound extends __BaseException {
|
|
|
1962
2101
|
*/
|
|
1963
2102
|
export interface GetServiceRequest {
|
|
1964
2103
|
/**
|
|
1965
|
-
* <p>The ID of the service that you want to get settings for
|
|
2104
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that you want to get settings for. For services created
|
|
2105
|
+
* by consumers in a shared namespace, specify the service ARN. For more information about shared
|
|
2106
|
+
* namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
2107
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1966
2108
|
* @public
|
|
1967
2109
|
*/
|
|
1968
2110
|
Id: string | undefined;
|
|
@@ -1982,13 +2124,17 @@ export interface GetServiceResponse {
|
|
|
1982
2124
|
*/
|
|
1983
2125
|
export interface GetServiceAttributesRequest {
|
|
1984
2126
|
/**
|
|
1985
|
-
* <p>The ID of the service that you want to get attributes for
|
|
2127
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that you want to get attributes for. For services created
|
|
2128
|
+
* in a namespace shared with your Amazon Web Services account, specify the service ARN. For more information
|
|
2129
|
+
* about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
2130
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1986
2131
|
* @public
|
|
1987
2132
|
*/
|
|
1988
2133
|
ServiceId: string | undefined;
|
|
1989
2134
|
}
|
|
1990
2135
|
/**
|
|
1991
|
-
* <p>A complex type that contains information about attributes associated with a specific
|
|
2136
|
+
* <p>A complex type that contains information about attributes associated with a specific
|
|
2137
|
+
* service.</p>
|
|
1992
2138
|
* @public
|
|
1993
2139
|
*/
|
|
1994
2140
|
export interface ServiceAttributes {
|
|
@@ -1997,9 +2143,17 @@ export interface ServiceAttributes {
|
|
|
1997
2143
|
* @public
|
|
1998
2144
|
*/
|
|
1999
2145
|
ServiceArn?: string | undefined;
|
|
2146
|
+
/**
|
|
2147
|
+
* <p>The ID of the Amazon Web Services account that created the namespace with which the service is associated.
|
|
2148
|
+
* If this isn't your account ID, it is the ID of the account that shared the namespace with your
|
|
2149
|
+
* account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map
|
|
2150
|
+
* namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
2151
|
+
* @public
|
|
2152
|
+
*/
|
|
2153
|
+
ResourceOwner?: string | undefined;
|
|
2000
2154
|
/**
|
|
2001
2155
|
* <p>A string map that contains the following information for the service that you specify in
|
|
2002
|
-
*
|
|
2156
|
+
* <code>ServiceArn</code>:</p>
|
|
2003
2157
|
* <ul>
|
|
2004
2158
|
* <li>
|
|
2005
2159
|
* <p>The attributes that apply to the service. </p>
|
|
@@ -2018,27 +2172,28 @@ export interface ServiceAttributes {
|
|
|
2018
2172
|
*/
|
|
2019
2173
|
export interface GetServiceAttributesResponse {
|
|
2020
2174
|
/**
|
|
2021
|
-
* <p>A complex type that contains the service ARN and a list of attribute key-value pairs
|
|
2175
|
+
* <p>A complex type that contains the service ARN and a list of attribute key-value pairs
|
|
2176
|
+
* associated with the service.</p>
|
|
2022
2177
|
* @public
|
|
2023
2178
|
*/
|
|
2024
2179
|
ServiceAttributes?: ServiceAttributes | undefined;
|
|
2025
2180
|
}
|
|
2026
2181
|
/**
|
|
2027
|
-
* <p>Updated properties
|
|
2028
|
-
* namespace.</p>
|
|
2182
|
+
* <p>Updated properties
|
|
2183
|
+
* for the HTTP namespace.</p>
|
|
2029
2184
|
* @public
|
|
2030
2185
|
*/
|
|
2031
2186
|
export interface HttpNamespaceChange {
|
|
2032
2187
|
/**
|
|
2033
|
-
* <p>An updated
|
|
2034
|
-
* namespace.</p>
|
|
2188
|
+
* <p>An updated
|
|
2189
|
+
* description for the HTTP namespace.</p>
|
|
2035
2190
|
* @public
|
|
2036
2191
|
*/
|
|
2037
2192
|
Description: string | undefined;
|
|
2038
2193
|
}
|
|
2039
2194
|
/**
|
|
2040
|
-
* <p>A complex type that contains information about the instances that you registered by using a
|
|
2041
|
-
* service.</p>
|
|
2195
|
+
* <p>A complex type that contains information about the instances that you registered by using a
|
|
2196
|
+
* specified service.</p>
|
|
2042
2197
|
* @public
|
|
2043
2198
|
*/
|
|
2044
2199
|
export interface InstanceSummary {
|
|
@@ -2061,68 +2216,81 @@ export interface InstanceSummary {
|
|
|
2061
2216
|
* <dl>
|
|
2062
2217
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
2063
2218
|
* <dd>
|
|
2064
|
-
* <p>For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
|
|
2065
|
-
* the load balancer. </p>
|
|
2219
|
+
* <p>For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
|
|
2220
|
+
* associated with the load balancer. </p>
|
|
2066
2221
|
* </dd>
|
|
2067
2222
|
* <dt>AWS_EC2_INSTANCE_ID (HTTP namespaces only)</dt>
|
|
2068
2223
|
* <dd>
|
|
2069
|
-
* <p>The Amazon EC2 instance ID for the instance. When the <code>AWS_EC2_INSTANCE_ID</code>
|
|
2070
|
-
* specified, then the <code>AWS_INSTANCE_IPV4</code> attribute contains the primary
|
|
2071
|
-
* address.</p>
|
|
2224
|
+
* <p>The Amazon EC2 instance ID for the instance. When the <code>AWS_EC2_INSTANCE_ID</code>
|
|
2225
|
+
* attribute is specified, then the <code>AWS_INSTANCE_IPV4</code> attribute contains the primary
|
|
2226
|
+
* private IPv4 address.</p>
|
|
2072
2227
|
* </dd>
|
|
2073
2228
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
2074
2229
|
* <dd>
|
|
2075
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
2076
|
-
*
|
|
2077
|
-
*
|
|
2230
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
2231
|
+
* optionally use <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom
|
|
2232
|
+
* health check, <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
2078
2233
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
2079
2234
|
* </dd>
|
|
2080
2235
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
2081
2236
|
* <dd>
|
|
2082
|
-
* <p>For a <code>CNAME</code> record, the domain name that Route 53 returns in response to DNS
|
|
2083
|
-
* example, <code>example.com</code>).</p>
|
|
2237
|
+
* <p>For a <code>CNAME</code> record, the domain name that Route 53 returns in response to DNS
|
|
2238
|
+
* queries (for example, <code>example.com</code>).</p>
|
|
2084
2239
|
* </dd>
|
|
2085
2240
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
2086
2241
|
* <dd>
|
|
2087
|
-
* <p>For an <code>A</code> record, the IPv4 address that Route 53 returns in response to DNS
|
|
2088
|
-
* example, <code>192.0.2.44</code>).</p>
|
|
2242
|
+
* <p>For an <code>A</code> record, the IPv4 address that Route 53 returns in response to DNS
|
|
2243
|
+
* queries (for example, <code>192.0.2.44</code>).</p>
|
|
2089
2244
|
* </dd>
|
|
2090
2245
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
2091
2246
|
* <dd>
|
|
2092
|
-
* <p>For an <code>AAAA</code> record, the IPv6 address that Route 53 returns in response to DNS
|
|
2093
|
-
* example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
2247
|
+
* <p>For an <code>AAAA</code> record, the IPv6 address that Route 53 returns in response to DNS
|
|
2248
|
+
* queries (for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
2094
2249
|
* </dd>
|
|
2095
2250
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
2096
2251
|
* <dd>
|
|
2097
|
-
* <p>For an <code>SRV</code> record, the value that Route 53 returns for the port. In addition,
|
|
2098
|
-
* includes <code>HealthCheckConfig</code>, the port on the endpoint that Route 53
|
|
2252
|
+
* <p>For an <code>SRV</code> record, the value that Route 53 returns for the port. In addition,
|
|
2253
|
+
* if the service includes <code>HealthCheckConfig</code>, the port on the endpoint that Route 53
|
|
2254
|
+
* sends requests to.</p>
|
|
2099
2255
|
* </dd>
|
|
2100
2256
|
* </dl>
|
|
2101
2257
|
* @public
|
|
2102
2258
|
*/
|
|
2103
2259
|
Attributes?: Record<string, string> | undefined;
|
|
2260
|
+
/**
|
|
2261
|
+
* <p>The ID of the Amazon Web Services account that registered the instance. If this isn't your account ID,
|
|
2262
|
+
* it's the ID of the account that shared the namespace with your account or the ID of another
|
|
2263
|
+
* account with which the namespace has been shared. For more information about shared namespaces,
|
|
2264
|
+
* see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account
|
|
2265
|
+
* Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
2266
|
+
* @public
|
|
2267
|
+
*/
|
|
2268
|
+
CreatedByAccount?: string | undefined;
|
|
2104
2269
|
}
|
|
2105
2270
|
/**
|
|
2106
2271
|
* @public
|
|
2107
2272
|
*/
|
|
2108
2273
|
export interface ListInstancesRequest {
|
|
2109
2274
|
/**
|
|
2110
|
-
* <p>The ID of the service that you want to list instances for
|
|
2275
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that you want to list instances for. For services created
|
|
2276
|
+
* in a shared namespace, specify the service ARN. For more information about shared namespaces,
|
|
2277
|
+
* see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account
|
|
2278
|
+
* Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
2111
2279
|
* @public
|
|
2112
2280
|
*/
|
|
2113
2281
|
ServiceId: string | undefined;
|
|
2114
2282
|
/**
|
|
2115
2283
|
* <p>For the first <code>ListInstances</code> request, omit this value.</p>
|
|
2116
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
2117
|
-
*
|
|
2284
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
2285
|
+
* another <code>ListInstances</code> request to get the next group of results. Specify the value of
|
|
2118
2286
|
* <code>NextToken</code> from the previous response in the next request.</p>
|
|
2119
2287
|
* @public
|
|
2120
2288
|
*/
|
|
2121
2289
|
NextToken?: string | undefined;
|
|
2122
2290
|
/**
|
|
2123
2291
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
2124
|
-
* <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2125
|
-
* returns up to 100 instances.</p>
|
|
2292
|
+
* <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2293
|
+
* Cloud Map returns up to 100 instances.</p>
|
|
2126
2294
|
* @public
|
|
2127
2295
|
*/
|
|
2128
2296
|
MaxResults?: number | undefined;
|
|
@@ -2132,13 +2300,21 @@ export interface ListInstancesRequest {
|
|
|
2132
2300
|
*/
|
|
2133
2301
|
export interface ListInstancesResponse {
|
|
2134
2302
|
/**
|
|
2135
|
-
* <p>
|
|
2303
|
+
* <p>The ID of the Amazon Web Services account that created the namespace that contains the specified service.
|
|
2304
|
+
* If this isn't your account ID, it's the ID of the account that shared the namespace with your
|
|
2305
|
+
* account.</p>
|
|
2306
|
+
* @public
|
|
2307
|
+
*/
|
|
2308
|
+
ResourceOwner?: string | undefined;
|
|
2309
|
+
/**
|
|
2310
|
+
* <p>Summary information about the instances that are associated with the specified
|
|
2311
|
+
* service.</p>
|
|
2136
2312
|
* @public
|
|
2137
2313
|
*/
|
|
2138
2314
|
Instances?: InstanceSummary[] | undefined;
|
|
2139
2315
|
/**
|
|
2140
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
2141
|
-
*
|
|
2316
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
2317
|
+
* another <code>ListInstances</code> request to get the next group of results. Specify the value of
|
|
2142
2318
|
* <code>NextToken</code> from the previous response in the next request.</p>
|
|
2143
2319
|
* @public
|
|
2144
2320
|
*/
|
|
@@ -2151,6 +2327,7 @@ export interface ListInstancesResponse {
|
|
|
2151
2327
|
export declare const NamespaceFilterName: {
|
|
2152
2328
|
readonly HTTP_NAME: "HTTP_NAME";
|
|
2153
2329
|
readonly NAME: "NAME";
|
|
2330
|
+
readonly RESOURCE_OWNER: "RESOURCE_OWNER";
|
|
2154
2331
|
readonly TYPE: "TYPE";
|
|
2155
2332
|
};
|
|
2156
2333
|
/**
|
|
@@ -2158,8 +2335,8 @@ export declare const NamespaceFilterName: {
|
|
|
2158
2335
|
*/
|
|
2159
2336
|
export type NamespaceFilterName = (typeof NamespaceFilterName)[keyof typeof NamespaceFilterName];
|
|
2160
2337
|
/**
|
|
2161
|
-
* <p>A complex type that identifies the namespaces that you want to list. You can choose to list
|
|
2162
|
-
* private namespaces.</p>
|
|
2338
|
+
* <p>A complex type that identifies the namespaces that you want to list. You can choose to list
|
|
2339
|
+
* public or private namespaces.</p>
|
|
2163
2340
|
* @public
|
|
2164
2341
|
*/
|
|
2165
2342
|
export interface NamespaceFilter {
|
|
@@ -2178,47 +2355,63 @@ export interface NamespaceFilter {
|
|
|
2178
2355
|
* <p>
|
|
2179
2356
|
* <code>HTTP_NAME</code>: Gets the namespaces with the specified HTTP name.</p>
|
|
2180
2357
|
* </li>
|
|
2358
|
+
* <li>
|
|
2359
|
+
* <p>
|
|
2360
|
+
* <code>RESOURCE_OWNER</code>: Gets the namespaces created by your Amazon Web Services account or by other
|
|
2361
|
+
* accounts. This can be used to filter for shared namespaces. For more information about shared
|
|
2362
|
+
* namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
2363
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
2364
|
+
* </li>
|
|
2181
2365
|
* </ul>
|
|
2182
2366
|
* @public
|
|
2183
2367
|
*/
|
|
2184
2368
|
Name: NamespaceFilterName | undefined;
|
|
2185
2369
|
/**
|
|
2186
|
-
* <p>Specify the values that are applicable to the value that you specify for
|
|
2370
|
+
* <p>Specify the values that are applicable to the value that you specify for
|
|
2371
|
+
* <code>Name</code>.</p>
|
|
2187
2372
|
* <ul>
|
|
2188
2373
|
* <li>
|
|
2189
2374
|
* <p>
|
|
2190
2375
|
* <code>TYPE</code>: Specify <code>HTTP</code>, <code>DNS_PUBLIC</code>, or
|
|
2191
|
-
*
|
|
2376
|
+
* <code>DNS_PRIVATE</code>.</p>
|
|
2192
2377
|
* </li>
|
|
2193
2378
|
* <li>
|
|
2194
2379
|
* <p>
|
|
2195
2380
|
* <code>NAME</code>: Specify the name of the namespace, which is found in
|
|
2196
|
-
*
|
|
2381
|
+
* <code>Namespace.Name</code>.</p>
|
|
2197
2382
|
* </li>
|
|
2198
2383
|
* <li>
|
|
2199
2384
|
* <p>
|
|
2200
2385
|
* <code>HTTP_NAME</code>: Specify the HTTP name of the namespace, which is found in
|
|
2201
2386
|
* <code>Namespace.Properties.HttpProperties.HttpName</code>.</p>
|
|
2202
2387
|
* </li>
|
|
2388
|
+
* <li>
|
|
2389
|
+
* <p>
|
|
2390
|
+
* <code>RESOURCE_OWNER</code>: Specify one of <code>SELF</code> or
|
|
2391
|
+
* <code>OTHER_ACCOUNTS</code>. <code>SELF</code> can be used to filter namespaces created by you
|
|
2392
|
+
* and <code>OTHER_ACCOUNTS</code> can be used to filter namespaces shared with you that were
|
|
2393
|
+
* created by other accounts.</p>
|
|
2394
|
+
* </li>
|
|
2203
2395
|
* </ul>
|
|
2204
2396
|
* @public
|
|
2205
2397
|
*/
|
|
2206
2398
|
Values: string[] | undefined;
|
|
2207
2399
|
/**
|
|
2208
|
-
* <p>Specify the operator that you want to use to determine whether a namespace matches the
|
|
2209
|
-
* Valid values for <code>Condition</code> are one of the following.</p>
|
|
2400
|
+
* <p>Specify the operator that you want to use to determine whether a namespace matches the
|
|
2401
|
+
* specified value. Valid values for <code>Condition</code> are one of the following.</p>
|
|
2210
2402
|
* <ul>
|
|
2211
2403
|
* <li>
|
|
2212
2404
|
* <p>
|
|
2213
|
-
* <code>EQ</code>: When you specify <code>EQ</code> for <code>Condition</code>, you can
|
|
2214
|
-
* value. <code>EQ</code> is supported for <code>TYPE</code>, <code>NAME</code>,
|
|
2215
|
-
* <code>EQ</code> is the default
|
|
2405
|
+
* <code>EQ</code>: When you specify <code>EQ</code> for <code>Condition</code>, you can
|
|
2406
|
+
* specify only one value. <code>EQ</code> is supported for <code>TYPE</code>, <code>NAME</code>,
|
|
2407
|
+
* <code>RESOURCE_OWNER</code> and <code>HTTP_NAME</code>. <code>EQ</code> is the default
|
|
2408
|
+
* condition and can be omitted.</p>
|
|
2216
2409
|
* </li>
|
|
2217
2410
|
* <li>
|
|
2218
2411
|
* <p>
|
|
2219
|
-
* <code>BEGINS_WITH</code>: When you specify <code>BEGINS_WITH</code> for
|
|
2220
|
-
*
|
|
2221
|
-
*
|
|
2412
|
+
* <code>BEGINS_WITH</code>: When you specify <code>BEGINS_WITH</code> for
|
|
2413
|
+
* <code>Condition</code>, you can specify only one value. <code>BEGINS_WITH</code> is supported
|
|
2414
|
+
* for <code>TYPE</code>, <code>NAME</code>, and <code>HTTP_NAME</code>.</p>
|
|
2222
2415
|
* </li>
|
|
2223
2416
|
* </ul>
|
|
2224
2417
|
* @public
|
|
@@ -2231,22 +2424,22 @@ export interface NamespaceFilter {
|
|
|
2231
2424
|
export interface ListNamespacesRequest {
|
|
2232
2425
|
/**
|
|
2233
2426
|
* <p>For the first <code>ListNamespaces</code> request, omit this value.</p>
|
|
2234
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
2235
|
-
* the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2236
|
-
* request.</p>
|
|
2427
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
2428
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2429
|
+
* previous response in the next request.</p>
|
|
2237
2430
|
* <note>
|
|
2238
|
-
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
2239
|
-
* It's possible that no namespaces in the first <code>MaxResults</code>
|
|
2240
|
-
* but that subsequent groups of <code>MaxResults</code>
|
|
2241
|
-
* criteria.</p>
|
|
2431
|
+
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
2432
|
+
* specified criteria. It's possible that no namespaces in the first <code>MaxResults</code>
|
|
2433
|
+
* namespaces matched the specified criteria but that subsequent groups of <code>MaxResults</code>
|
|
2434
|
+
* namespaces do contain namespaces that match the criteria.</p>
|
|
2242
2435
|
* </note>
|
|
2243
2436
|
* @public
|
|
2244
2437
|
*/
|
|
2245
2438
|
NextToken?: string | undefined;
|
|
2246
2439
|
/**
|
|
2247
2440
|
* <p>The maximum number of namespaces that you want Cloud Map to return in the response to a
|
|
2248
|
-
* <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2249
|
-
* returns up to 100 namespaces.</p>
|
|
2441
|
+
* <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2442
|
+
* Cloud Map returns up to 100 namespaces.</p>
|
|
2250
2443
|
* @public
|
|
2251
2444
|
*/
|
|
2252
2445
|
MaxResults?: number | undefined;
|
|
@@ -2274,8 +2467,16 @@ export interface NamespaceSummary {
|
|
|
2274
2467
|
*/
|
|
2275
2468
|
Arn?: string | undefined;
|
|
2276
2469
|
/**
|
|
2277
|
-
* <p>The
|
|
2278
|
-
*
|
|
2470
|
+
* <p>The ID of the Amazon Web Services account that created the namespace. If this isn't your account ID, it's
|
|
2471
|
+
* the ID of the account that shared the namespace with your account. For more information about
|
|
2472
|
+
* shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
2473
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
2474
|
+
* @public
|
|
2475
|
+
*/
|
|
2476
|
+
ResourceOwner?: string | undefined;
|
|
2477
|
+
/**
|
|
2478
|
+
* <p>The name of the namespace. When you create a namespace, Cloud Map automatically creates a
|
|
2479
|
+
* Route 53 hosted zone that has the same name as the namespace.</p>
|
|
2279
2480
|
* @public
|
|
2280
2481
|
*/
|
|
2281
2482
|
Name?: string | undefined;
|
|
@@ -2310,20 +2511,20 @@ export interface NamespaceSummary {
|
|
|
2310
2511
|
*/
|
|
2311
2512
|
export interface ListNamespacesResponse {
|
|
2312
2513
|
/**
|
|
2313
|
-
* <p>An array that contains one <code>NamespaceSummary</code> object for each namespace that
|
|
2314
|
-
* specified filter criteria.</p>
|
|
2514
|
+
* <p>An array that contains one <code>NamespaceSummary</code> object for each namespace that
|
|
2515
|
+
* matches the specified filter criteria.</p>
|
|
2315
2516
|
* @public
|
|
2316
2517
|
*/
|
|
2317
2518
|
Namespaces?: NamespaceSummary[] | undefined;
|
|
2318
2519
|
/**
|
|
2319
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
2320
|
-
* the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2321
|
-
* request.</p>
|
|
2520
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
2521
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2522
|
+
* previous response in the next request.</p>
|
|
2322
2523
|
* <note>
|
|
2323
|
-
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
2324
|
-
* It's possible that no namespaces in the first <code>MaxResults</code>
|
|
2325
|
-
* but that subsequent groups of <code>MaxResults</code>
|
|
2326
|
-
* criteria.</p>
|
|
2524
|
+
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
2525
|
+
* specified criteria. It's possible that no namespaces in the first <code>MaxResults</code>
|
|
2526
|
+
* namespaces matched the specified criteria but that subsequent groups of <code>MaxResults</code>
|
|
2527
|
+
* namespaces do contain namespaces that match the criteria.</p>
|
|
2327
2528
|
* </note>
|
|
2328
2529
|
* @public
|
|
2329
2530
|
*/
|
|
@@ -2354,16 +2555,19 @@ export interface OperationFilter {
|
|
|
2354
2555
|
* <ul>
|
|
2355
2556
|
* <li>
|
|
2356
2557
|
* <p>
|
|
2357
|
-
* <b>NAMESPACE_ID</b>: Gets operations related to specified
|
|
2558
|
+
* <b>NAMESPACE_ID</b>: Gets operations related to specified
|
|
2559
|
+
* namespaces.</p>
|
|
2358
2560
|
* </li>
|
|
2359
2561
|
* <li>
|
|
2360
2562
|
* <p>
|
|
2361
|
-
* <b>SERVICE_ID</b>: Gets operations related to specified
|
|
2563
|
+
* <b>SERVICE_ID</b>: Gets operations related to specified
|
|
2564
|
+
* services.</p>
|
|
2362
2565
|
* </li>
|
|
2363
2566
|
* <li>
|
|
2364
2567
|
* <p>
|
|
2365
|
-
* <b>STATUS</b>: Gets operations based on the status of the
|
|
2366
|
-
*
|
|
2568
|
+
* <b>STATUS</b>: Gets operations based on the status of the
|
|
2569
|
+
* operations: <code>SUBMITTED</code>, <code>PENDING</code>, <code>SUCCEED</code>, or
|
|
2570
|
+
* <code>FAIL</code>.</p>
|
|
2367
2571
|
* </li>
|
|
2368
2572
|
* <li>
|
|
2369
2573
|
* <p>
|
|
@@ -2371,8 +2575,8 @@ export interface OperationFilter {
|
|
|
2371
2575
|
* </li>
|
|
2372
2576
|
* <li>
|
|
2373
2577
|
* <p>
|
|
2374
|
-
* <b>UPDATE_DATE</b>: Gets operations that changed status during a
|
|
2375
|
-
* date/time range. </p>
|
|
2578
|
+
* <b>UPDATE_DATE</b>: Gets operations that changed status during a
|
|
2579
|
+
* specified date/time range. </p>
|
|
2376
2580
|
* </li>
|
|
2377
2581
|
* </ul>
|
|
2378
2582
|
* @public
|
|
@@ -2391,8 +2595,9 @@ export interface OperationFilter {
|
|
|
2391
2595
|
* </li>
|
|
2392
2596
|
* <li>
|
|
2393
2597
|
* <p>
|
|
2394
|
-
* <b>STATUS</b>: Specify one or more statuses:
|
|
2395
|
-
* <code>
|
|
2598
|
+
* <b>STATUS</b>: Specify one or more statuses:
|
|
2599
|
+
* <code>SUBMITTED</code>, <code>PENDING</code>, <code>SUCCEED</code>, or
|
|
2600
|
+
* <code>FAIL</code>.</p>
|
|
2396
2601
|
* </li>
|
|
2397
2602
|
* <li>
|
|
2398
2603
|
* <p>
|
|
@@ -2402,34 +2607,37 @@ export interface OperationFilter {
|
|
|
2402
2607
|
* </li>
|
|
2403
2608
|
* <li>
|
|
2404
2609
|
* <p>
|
|
2405
|
-
* <b>UPDATE_DATE</b>: Specify a start date and an end date in Unix
|
|
2406
|
-
* format and Coordinated Universal Time (UTC). The start date must be the first
|
|
2610
|
+
* <b>UPDATE_DATE</b>: Specify a start date and an end date in Unix
|
|
2611
|
+
* date/time format and Coordinated Universal Time (UTC). The start date must be the first
|
|
2612
|
+
* value.</p>
|
|
2407
2613
|
* </li>
|
|
2408
2614
|
* </ul>
|
|
2409
2615
|
* @public
|
|
2410
2616
|
*/
|
|
2411
2617
|
Values: string[] | undefined;
|
|
2412
2618
|
/**
|
|
2413
|
-
* <p>The operator that you want to use to determine whether an operation matches the specified
|
|
2414
|
-
* values for condition include:</p>
|
|
2619
|
+
* <p>The operator that you want to use to determine whether an operation matches the specified
|
|
2620
|
+
* value. Valid values for condition include:</p>
|
|
2415
2621
|
* <ul>
|
|
2416
2622
|
* <li>
|
|
2417
2623
|
* <p>
|
|
2418
|
-
* <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only
|
|
2419
|
-
*
|
|
2420
|
-
* <code>TYPE</code>. <code>EQ</code> is the default condition and can
|
|
2624
|
+
* <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only
|
|
2625
|
+
* one value. <code>EQ</code> is supported for <code>NAMESPACE_ID</code>, <code>SERVICE_ID</code>,
|
|
2626
|
+
* <code>STATUS</code>, and <code>TYPE</code>. <code>EQ</code> is the default condition and can
|
|
2627
|
+
* be omitted.</p>
|
|
2421
2628
|
* </li>
|
|
2422
2629
|
* <li>
|
|
2423
2630
|
* <p>
|
|
2424
|
-
* <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a
|
|
2425
|
-
* more values. <code>IN</code> is supported for <code>STATUS</code> and
|
|
2426
|
-
*
|
|
2631
|
+
* <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a
|
|
2632
|
+
* list of one or more values. <code>IN</code> is supported for <code>STATUS</code> and
|
|
2633
|
+
* <code>TYPE</code>. An operation must match one of the specified values to be returned in the
|
|
2634
|
+
* response.</p>
|
|
2427
2635
|
* </li>
|
|
2428
2636
|
* <li>
|
|
2429
2637
|
* <p>
|
|
2430
|
-
* <code>BETWEEN</code>: Specify a start date and an end date in Unix date/time format and
|
|
2431
|
-
* Universal Time (UTC). The start date must be the first value. <code>BETWEEN</code>
|
|
2432
|
-
*
|
|
2638
|
+
* <code>BETWEEN</code>: Specify a start date and an end date in Unix date/time format and
|
|
2639
|
+
* Coordinated Universal Time (UTC). The start date must be the first value. <code>BETWEEN</code>
|
|
2640
|
+
* is supported for <code>UPDATE_DATE</code>. </p>
|
|
2433
2641
|
* </li>
|
|
2434
2642
|
* </ul>
|
|
2435
2643
|
* @public
|
|
@@ -2442,28 +2650,28 @@ export interface OperationFilter {
|
|
|
2442
2650
|
export interface ListOperationsRequest {
|
|
2443
2651
|
/**
|
|
2444
2652
|
* <p>For the first <code>ListOperations</code> request, omit this value.</p>
|
|
2445
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
2446
|
-
* the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2447
|
-
* request.</p>
|
|
2653
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
2654
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2655
|
+
* previous response in the next request.</p>
|
|
2448
2656
|
* <note>
|
|
2449
|
-
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
2450
|
-
* It's possible that no operations in the first <code>MaxResults</code>
|
|
2451
|
-
* but that subsequent groups of <code>MaxResults</code>
|
|
2452
|
-
* criteria.</p>
|
|
2657
|
+
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
2658
|
+
* specified criteria. It's possible that no operations in the first <code>MaxResults</code>
|
|
2659
|
+
* operations matched the specified criteria but that subsequent groups of <code>MaxResults</code>
|
|
2660
|
+
* operations do contain operations that match the criteria.</p>
|
|
2453
2661
|
* </note>
|
|
2454
2662
|
* @public
|
|
2455
2663
|
*/
|
|
2456
2664
|
NextToken?: string | undefined;
|
|
2457
2665
|
/**
|
|
2458
2666
|
* <p>The maximum number of items that you want Cloud Map to return in the response to a
|
|
2459
|
-
* <code>ListOperations</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2460
|
-
* returns up to 100 operations.</p>
|
|
2667
|
+
* <code>ListOperations</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2668
|
+
* Cloud Map returns up to 100 operations.</p>
|
|
2461
2669
|
* @public
|
|
2462
2670
|
*/
|
|
2463
2671
|
MaxResults?: number | undefined;
|
|
2464
2672
|
/**
|
|
2465
|
-
* <p>A complex type that contains specifications for the operations that you want to list, for
|
|
2466
|
-
* operations that you started between a specified start date and end date.</p>
|
|
2673
|
+
* <p>A complex type that contains specifications for the operations that you want to list, for
|
|
2674
|
+
* example, operations that you started between a specified start date and end date.</p>
|
|
2467
2675
|
* <p>If you specify more than one filter, an operation must match all filters to be returned by
|
|
2468
2676
|
* <code>ListOperations</code>.</p>
|
|
2469
2677
|
* @public
|
|
@@ -2471,9 +2679,8 @@ export interface ListOperationsRequest {
|
|
|
2471
2679
|
Filters?: OperationFilter[] | undefined;
|
|
2472
2680
|
}
|
|
2473
2681
|
/**
|
|
2474
|
-
* <p>A complex type that contains information about an operation that matches the criteria that
|
|
2475
|
-
* a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html">ListOperations</a>
|
|
2476
|
-
* request.</p>
|
|
2682
|
+
* <p>A complex type that contains information about an operation that matches the criteria that
|
|
2683
|
+
* you specified in a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html">ListOperations</a> request.</p>
|
|
2477
2684
|
* @public
|
|
2478
2685
|
*/
|
|
2479
2686
|
export interface OperationSummary {
|
|
@@ -2487,8 +2694,8 @@ export interface OperationSummary {
|
|
|
2487
2694
|
* <ul>
|
|
2488
2695
|
* <li>
|
|
2489
2696
|
* <p>
|
|
2490
|
-
* <b>SUBMITTED</b>: This is the initial state immediately after
|
|
2491
|
-
* request.</p>
|
|
2697
|
+
* <b>SUBMITTED</b>: This is the initial state immediately after
|
|
2698
|
+
* you submit a request.</p>
|
|
2492
2699
|
* </li>
|
|
2493
2700
|
* <li>
|
|
2494
2701
|
* <p>
|
|
@@ -2518,14 +2725,14 @@ export interface ListOperationsResponse {
|
|
|
2518
2725
|
*/
|
|
2519
2726
|
Operations?: OperationSummary[] | undefined;
|
|
2520
2727
|
/**
|
|
2521
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
2522
|
-
* the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2523
|
-
* request.</p>
|
|
2728
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
2729
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2730
|
+
* previous response in the next request.</p>
|
|
2524
2731
|
* <note>
|
|
2525
|
-
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
2526
|
-
* It's possible that no operations in the first <code>MaxResults</code>
|
|
2527
|
-
* but that subsequent groups of <code>MaxResults</code>
|
|
2528
|
-
* criteria.</p>
|
|
2732
|
+
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
2733
|
+
* specified criteria. It's possible that no operations in the first <code>MaxResults</code>
|
|
2734
|
+
* operations matched the specified criteria but that subsequent groups of <code>MaxResults</code>
|
|
2735
|
+
* operations do contain operations that match the criteria.</p>
|
|
2529
2736
|
* </note>
|
|
2530
2737
|
* @public
|
|
2531
2738
|
*/
|
|
@@ -2537,35 +2744,65 @@ export interface ListOperationsResponse {
|
|
|
2537
2744
|
*/
|
|
2538
2745
|
export declare const ServiceFilterName: {
|
|
2539
2746
|
readonly NAMESPACE_ID: "NAMESPACE_ID";
|
|
2747
|
+
readonly RESOURCE_OWNER: "RESOURCE_OWNER";
|
|
2540
2748
|
};
|
|
2541
2749
|
/**
|
|
2542
2750
|
* @public
|
|
2543
2751
|
*/
|
|
2544
2752
|
export type ServiceFilterName = (typeof ServiceFilterName)[keyof typeof ServiceFilterName];
|
|
2545
2753
|
/**
|
|
2546
|
-
* <p>A complex type that lets you specify the namespaces that you want to list services
|
|
2754
|
+
* <p>A complex type that lets you specify the namespaces that you want to list services
|
|
2755
|
+
* for.</p>
|
|
2547
2756
|
* @public
|
|
2548
2757
|
*/
|
|
2549
2758
|
export interface ServiceFilter {
|
|
2550
2759
|
/**
|
|
2551
|
-
* <p>Specify
|
|
2760
|
+
* <p>Specify the services that you want to get using one of the following.</p>
|
|
2761
|
+
* <ul>
|
|
2762
|
+
* <li>
|
|
2763
|
+
* <p>
|
|
2764
|
+
* <code>NAMESPACE_ID</code>: Gets the services associated with the specified
|
|
2765
|
+
* namespace.</p>
|
|
2766
|
+
* </li>
|
|
2767
|
+
* <li>
|
|
2768
|
+
* <p>
|
|
2769
|
+
* <code>RESOURCE_OWNER</code>: Gets the services associated with the namespaces created by
|
|
2770
|
+
* your Amazon Web Services account or by other accounts. This can be used to filter for services created in a
|
|
2771
|
+
* shared namespace. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map
|
|
2772
|
+
* namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
2773
|
+
* </li>
|
|
2774
|
+
* </ul>
|
|
2552
2775
|
* @public
|
|
2553
2776
|
*/
|
|
2554
2777
|
Name: ServiceFilterName | undefined;
|
|
2555
2778
|
/**
|
|
2556
|
-
* <p>The values that are applicable to the value that you specify for <code>Condition</code> to
|
|
2557
|
-
* of services.</p>
|
|
2779
|
+
* <p>The values that are applicable to the value that you specify for <code>Condition</code> to
|
|
2780
|
+
* filter the list of services.</p>
|
|
2781
|
+
* <ul>
|
|
2782
|
+
* <li>
|
|
2783
|
+
* <p>
|
|
2784
|
+
* <b>NAMESPACE_ID</b>: Specify one namespace ID or ARN. Specify
|
|
2785
|
+
* the namespace ARN for namespaces that are shared with your Amazon Web Services account.</p>
|
|
2786
|
+
* </li>
|
|
2787
|
+
* <li>
|
|
2788
|
+
* <p>
|
|
2789
|
+
* <b>RESOURCE_OWNER</b>: Specify one of <code>SELF</code> or
|
|
2790
|
+
* <code>OTHER_ACCOUNTS</code>. <code>SELF</code> can be used to filter services associated with
|
|
2791
|
+
* namespaces created by you and <code>OTHER_ACCOUNTS</code> can be used to filter services
|
|
2792
|
+
* associated with namespaces that were shared with you.</p>
|
|
2793
|
+
* </li>
|
|
2794
|
+
* </ul>
|
|
2558
2795
|
* @public
|
|
2559
2796
|
*/
|
|
2560
2797
|
Values: string[] | undefined;
|
|
2561
2798
|
/**
|
|
2562
|
-
* <p>The operator that you want to use to determine whether a service is returned by
|
|
2563
|
-
*
|
|
2799
|
+
* <p>The operator that you want to use to determine whether a service is returned by
|
|
2800
|
+
* <code>ListServices</code>. Valid values for <code>Condition</code> include the following:</p>
|
|
2564
2801
|
* <ul>
|
|
2565
2802
|
* <li>
|
|
2566
2803
|
* <p>
|
|
2567
|
-
* <code>EQ</code>: When you specify <code>EQ</code>, specify one
|
|
2568
|
-
*
|
|
2804
|
+
* <code>EQ</code>: When you specify <code>EQ</code>, specify one value. <code>EQ</code> is
|
|
2805
|
+
* the default condition and can be omitted.</p>
|
|
2569
2806
|
* </li>
|
|
2570
2807
|
* </ul>
|
|
2571
2808
|
* @public
|
|
@@ -2578,26 +2815,28 @@ export interface ServiceFilter {
|
|
|
2578
2815
|
export interface ListServicesRequest {
|
|
2579
2816
|
/**
|
|
2580
2817
|
* <p>For the first <code>ListServices</code> request, omit this value.</p>
|
|
2581
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2582
|
-
* the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2583
|
-
* request.</p>
|
|
2818
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2819
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2820
|
+
* previous response in the next request.</p>
|
|
2584
2821
|
* <note>
|
|
2585
|
-
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2586
|
-
* It's possible that no services in the first <code>MaxResults</code> services
|
|
2587
|
-
* that subsequent groups of <code>MaxResults</code> services do
|
|
2822
|
+
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2823
|
+
* specified criteria. It's possible that no services in the first <code>MaxResults</code> services
|
|
2824
|
+
* matched the specified criteria but that subsequent groups of <code>MaxResults</code> services do
|
|
2825
|
+
* contain services that match the criteria.</p>
|
|
2588
2826
|
* </note>
|
|
2589
2827
|
* @public
|
|
2590
2828
|
*/
|
|
2591
2829
|
NextToken?: string | undefined;
|
|
2592
2830
|
/**
|
|
2593
2831
|
* <p>The maximum number of services that you want Cloud Map to return in the response to a
|
|
2594
|
-
* <code>ListServices</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2595
|
-
* up to 100 services.</p>
|
|
2832
|
+
* <code>ListServices</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2833
|
+
* Cloud Map returns up to 100 services.</p>
|
|
2596
2834
|
* @public
|
|
2597
2835
|
*/
|
|
2598
2836
|
MaxResults?: number | undefined;
|
|
2599
2837
|
/**
|
|
2600
|
-
* <p>A complex type that contains specifications for the namespaces that you want to list
|
|
2838
|
+
* <p>A complex type that contains specifications for the namespaces that you want to list
|
|
2839
|
+
* services for. </p>
|
|
2601
2840
|
* <p>If you specify more than one filter, an operation must match all filters to be returned by
|
|
2602
2841
|
* <code>ListServices</code>.</p>
|
|
2603
2842
|
* @public
|
|
@@ -2619,6 +2858,14 @@ export interface ServiceSummary {
|
|
|
2619
2858
|
* @public
|
|
2620
2859
|
*/
|
|
2621
2860
|
Arn?: string | undefined;
|
|
2861
|
+
/**
|
|
2862
|
+
* <p>The ID of the Amazon Web Services account that created the namespace with which the service is associated.
|
|
2863
|
+
* If this isn't your account ID, it is the ID of the account that shared the namespace with your
|
|
2864
|
+
* account. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map
|
|
2865
|
+
* namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
2866
|
+
* @public
|
|
2867
|
+
*/
|
|
2868
|
+
ResourceOwner?: string | undefined;
|
|
2622
2869
|
/**
|
|
2623
2870
|
* <p>The name of the service.</p>
|
|
2624
2871
|
* @public
|
|
@@ -2629,8 +2876,8 @@ export interface ServiceSummary {
|
|
|
2629
2876
|
* <dl>
|
|
2630
2877
|
* <dt>DNS_HTTP</dt>
|
|
2631
2878
|
* <dd>
|
|
2632
|
-
* <p>The service instances can be discovered using either DNS queries or the
|
|
2633
|
-
*
|
|
2879
|
+
* <p>The service instances can be discovered using either DNS queries or the
|
|
2880
|
+
* <code>DiscoverInstances</code> API operation.</p>
|
|
2634
2881
|
* </dd>
|
|
2635
2882
|
* <dt>HTTP</dt>
|
|
2636
2883
|
* <dd>
|
|
@@ -2651,43 +2898,45 @@ export interface ServiceSummary {
|
|
|
2651
2898
|
*/
|
|
2652
2899
|
Description?: string | undefined;
|
|
2653
2900
|
/**
|
|
2654
|
-
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
2655
|
-
* associated with the service but that are deleted aren't included in the count. The
|
|
2656
|
-
* pending registrations and deregistrations.</p>
|
|
2901
|
+
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
2902
|
+
* previously associated with the service but that are deleted aren't included in the count. The
|
|
2903
|
+
* count might not reflect pending registrations and deregistrations.</p>
|
|
2657
2904
|
* @public
|
|
2658
2905
|
*/
|
|
2659
2906
|
InstanceCount?: number | undefined;
|
|
2660
2907
|
/**
|
|
2661
|
-
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
|
|
2662
|
-
* instance.</p>
|
|
2908
|
+
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
|
|
2909
|
+
* an instance.</p>
|
|
2663
2910
|
* @public
|
|
2664
2911
|
*/
|
|
2665
2912
|
DnsConfig?: DnsConfig | undefined;
|
|
2666
2913
|
/**
|
|
2667
2914
|
* <p>
|
|
2668
|
-
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
2669
|
-
* specify settings for a health check, Cloud Map associates the health check with
|
|
2670
|
-
*
|
|
2915
|
+
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
2916
|
+
* check. If you specify settings for a health check, Cloud Map associates the health check with
|
|
2917
|
+
* the records that you specify in <code>DnsConfig</code>.</p>
|
|
2671
2918
|
* @public
|
|
2672
2919
|
*/
|
|
2673
2920
|
HealthCheckConfig?: HealthCheckConfig | undefined;
|
|
2674
2921
|
/**
|
|
2675
|
-
* <p>Information about an optional custom health check. A custom health check, which requires
|
|
2676
|
-
* third-party health checker to evaluate the health of your resources, is useful in
|
|
2677
|
-
* circumstances:</p>
|
|
2922
|
+
* <p>Information about an optional custom health check. A custom health check, which requires
|
|
2923
|
+
* that you use a third-party health checker to evaluate the health of your resources, is useful in
|
|
2924
|
+
* the following circumstances:</p>
|
|
2678
2925
|
* <ul>
|
|
2679
2926
|
* <li>
|
|
2680
|
-
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
2681
|
-
* available over the internet. For example, you can use a custom health check when
|
|
2682
|
-
* VPC. (To check the health of resources in a VPC, the health
|
|
2927
|
+
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
2928
|
+
* resource isn't available over the internet. For example, you can use a custom health check when
|
|
2929
|
+
* the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health
|
|
2930
|
+
* checker must also be in the VPC.)</p>
|
|
2683
2931
|
* </li>
|
|
2684
2932
|
* <li>
|
|
2685
|
-
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
2933
|
+
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
2934
|
+
* located.</p>
|
|
2686
2935
|
* </li>
|
|
2687
2936
|
* </ul>
|
|
2688
2937
|
* <important>
|
|
2689
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
2690
|
-
*
|
|
2938
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
2939
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
2691
2940
|
* </important>
|
|
2692
2941
|
* @public
|
|
2693
2942
|
*/
|
|
@@ -2697,25 +2946,34 @@ export interface ServiceSummary {
|
|
|
2697
2946
|
* @public
|
|
2698
2947
|
*/
|
|
2699
2948
|
CreateDate?: Date | undefined;
|
|
2949
|
+
/**
|
|
2950
|
+
* <p>The ID of the Amazon Web Services account that created the service. If this isn't your account ID, it is
|
|
2951
|
+
* the account ID of the namespace owner or of another account with which the namespace has been
|
|
2952
|
+
* shared. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map
|
|
2953
|
+
* namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
2954
|
+
* @public
|
|
2955
|
+
*/
|
|
2956
|
+
CreatedByAccount?: string | undefined;
|
|
2700
2957
|
}
|
|
2701
2958
|
/**
|
|
2702
2959
|
* @public
|
|
2703
2960
|
*/
|
|
2704
2961
|
export interface ListServicesResponse {
|
|
2705
2962
|
/**
|
|
2706
|
-
* <p>An array that contains one <code>ServiceSummary</code> object for each service that matches
|
|
2707
|
-
* filter criteria.</p>
|
|
2963
|
+
* <p>An array that contains one <code>ServiceSummary</code> object for each service that matches
|
|
2964
|
+
* the specified filter criteria.</p>
|
|
2708
2965
|
* @public
|
|
2709
2966
|
*/
|
|
2710
2967
|
Services?: ServiceSummary[] | undefined;
|
|
2711
2968
|
/**
|
|
2712
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2713
|
-
* the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2714
|
-
* request.</p>
|
|
2969
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2970
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2971
|
+
* previous response in the next request.</p>
|
|
2715
2972
|
* <note>
|
|
2716
|
-
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2717
|
-
* It's possible that no services in the first <code>MaxResults</code> services
|
|
2718
|
-
* that subsequent groups of <code>MaxResults</code> services do
|
|
2973
|
+
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2974
|
+
* specified criteria. It's possible that no services in the first <code>MaxResults</code> services
|
|
2975
|
+
* matched the specified criteria but that subsequent groups of <code>MaxResults</code> services do
|
|
2976
|
+
* contain services that match the criteria.</p>
|
|
2719
2977
|
* </note>
|
|
2720
2978
|
* @public
|
|
2721
2979
|
*/
|
|
@@ -2755,104 +3013,106 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
2755
3013
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
2756
3014
|
}
|
|
2757
3015
|
/**
|
|
2758
|
-
* <p>Updated Start of
|
|
2759
|
-
* properties for a public or private DNS namespace.</p>
|
|
3016
|
+
* <p>Updated Start of
|
|
3017
|
+
* Authority (SOA) properties for a public or private DNS namespace.</p>
|
|
2760
3018
|
* @public
|
|
2761
3019
|
*/
|
|
2762
3020
|
export interface SOAChange {
|
|
2763
3021
|
/**
|
|
2764
|
-
* <p>The updated time to
|
|
2765
|
-
* purposes of negative caching.</p>
|
|
3022
|
+
* <p>The updated time to
|
|
3023
|
+
* live (TTL) for purposes of negative caching.</p>
|
|
2766
3024
|
* @public
|
|
2767
3025
|
*/
|
|
2768
3026
|
TTL: number | undefined;
|
|
2769
3027
|
}
|
|
2770
3028
|
/**
|
|
2771
|
-
* <p>Updated DNS
|
|
2772
|
-
* private DNS namespace.</p>
|
|
3029
|
+
* <p>Updated DNS
|
|
3030
|
+
* properties for the private DNS namespace.</p>
|
|
2773
3031
|
* @public
|
|
2774
3032
|
*/
|
|
2775
3033
|
export interface PrivateDnsPropertiesMutableChange {
|
|
2776
3034
|
/**
|
|
2777
|
-
* <p>Updated fields for
|
|
2778
|
-
* Authority (SOA) record for the hosted zone for the private DNS
|
|
3035
|
+
* <p>Updated fields for
|
|
3036
|
+
* the Start of Authority (SOA) record for the hosted zone for the private DNS
|
|
3037
|
+
* namespace.</p>
|
|
2779
3038
|
* @public
|
|
2780
3039
|
*/
|
|
2781
3040
|
SOA: SOAChange | undefined;
|
|
2782
3041
|
}
|
|
2783
3042
|
/**
|
|
2784
|
-
* <p>Updated properties
|
|
2785
|
-
* DNS namespace.</p>
|
|
3043
|
+
* <p>Updated properties
|
|
3044
|
+
* for the private DNS namespace.</p>
|
|
2786
3045
|
* @public
|
|
2787
3046
|
*/
|
|
2788
3047
|
export interface PrivateDnsNamespacePropertiesChange {
|
|
2789
3048
|
/**
|
|
2790
|
-
* <p>Updated DNS
|
|
2791
|
-
* private DNS namespace.</p>
|
|
3049
|
+
* <p>Updated DNS
|
|
3050
|
+
* properties for the private DNS namespace.</p>
|
|
2792
3051
|
* @public
|
|
2793
3052
|
*/
|
|
2794
3053
|
DnsProperties: PrivateDnsPropertiesMutableChange | undefined;
|
|
2795
3054
|
}
|
|
2796
3055
|
/**
|
|
2797
|
-
* <p>Updated properties
|
|
2798
|
-
* DNS namespace.</p>
|
|
3056
|
+
* <p>Updated properties
|
|
3057
|
+
* for the private DNS namespace.</p>
|
|
2799
3058
|
* @public
|
|
2800
3059
|
*/
|
|
2801
3060
|
export interface PrivateDnsNamespaceChange {
|
|
2802
3061
|
/**
|
|
2803
|
-
* <p>An updated
|
|
2804
|
-
* private DNS namespace.</p>
|
|
3062
|
+
* <p>An updated
|
|
3063
|
+
* description for the private DNS namespace.</p>
|
|
2805
3064
|
* @public
|
|
2806
3065
|
*/
|
|
2807
3066
|
Description?: string | undefined;
|
|
2808
3067
|
/**
|
|
2809
|
-
* <p>Properties to be
|
|
2810
|
-
* private DNS namespace.</p>
|
|
3068
|
+
* <p>Properties to be
|
|
3069
|
+
* updated in the private DNS namespace.</p>
|
|
2811
3070
|
* @public
|
|
2812
3071
|
*/
|
|
2813
3072
|
Properties?: PrivateDnsNamespacePropertiesChange | undefined;
|
|
2814
3073
|
}
|
|
2815
3074
|
/**
|
|
2816
|
-
* <p>Updated DNS
|
|
2817
|
-
* public DNS namespace.</p>
|
|
3075
|
+
* <p>Updated DNS
|
|
3076
|
+
* properties for the public DNS namespace.</p>
|
|
2818
3077
|
* @public
|
|
2819
3078
|
*/
|
|
2820
3079
|
export interface PublicDnsPropertiesMutableChange {
|
|
2821
3080
|
/**
|
|
2822
|
-
* <p>Updated fields for
|
|
2823
|
-
* Authority (SOA) record for the hosted zone for the public DNS
|
|
3081
|
+
* <p>Updated fields for
|
|
3082
|
+
* the Start of Authority (SOA) record for the hosted zone for the public DNS
|
|
3083
|
+
* namespace.</p>
|
|
2824
3084
|
* @public
|
|
2825
3085
|
*/
|
|
2826
3086
|
SOA: SOAChange | undefined;
|
|
2827
3087
|
}
|
|
2828
3088
|
/**
|
|
2829
|
-
* <p>Updated properties
|
|
2830
|
-
* DNS namespace.</p>
|
|
3089
|
+
* <p>Updated properties
|
|
3090
|
+
* for the public DNS namespace.</p>
|
|
2831
3091
|
* @public
|
|
2832
3092
|
*/
|
|
2833
3093
|
export interface PublicDnsNamespacePropertiesChange {
|
|
2834
3094
|
/**
|
|
2835
|
-
* <p>Updated DNS
|
|
2836
|
-
* hosted zone for the public DNS namespace.</p>
|
|
3095
|
+
* <p>Updated DNS
|
|
3096
|
+
* properties for the hosted zone for the public DNS namespace.</p>
|
|
2837
3097
|
* @public
|
|
2838
3098
|
*/
|
|
2839
3099
|
DnsProperties: PublicDnsPropertiesMutableChange | undefined;
|
|
2840
3100
|
}
|
|
2841
3101
|
/**
|
|
2842
|
-
* <p>Updated properties
|
|
2843
|
-
* DNS namespace.</p>
|
|
3102
|
+
* <p>Updated properties
|
|
3103
|
+
* for the public DNS namespace.</p>
|
|
2844
3104
|
* @public
|
|
2845
3105
|
*/
|
|
2846
3106
|
export interface PublicDnsNamespaceChange {
|
|
2847
3107
|
/**
|
|
2848
|
-
* <p>An updated
|
|
2849
|
-
* public DNS namespace.</p>
|
|
3108
|
+
* <p>An updated
|
|
3109
|
+
* description for the public DNS namespace.</p>
|
|
2850
3110
|
* @public
|
|
2851
3111
|
*/
|
|
2852
3112
|
Description?: string | undefined;
|
|
2853
3113
|
/**
|
|
2854
|
-
* <p>Properties to be
|
|
2855
|
-
* public DNS namespace.</p>
|
|
3114
|
+
* <p>Properties to be
|
|
3115
|
+
* updated in the public DNS namespace.</p>
|
|
2856
3116
|
* @public
|
|
2857
3117
|
*/
|
|
2858
3118
|
Properties?: PublicDnsNamespacePropertiesChange | undefined;
|
|
@@ -2862,7 +3122,10 @@ export interface PublicDnsNamespaceChange {
|
|
|
2862
3122
|
*/
|
|
2863
3123
|
export interface RegisterInstanceRequest {
|
|
2864
3124
|
/**
|
|
2865
|
-
* <p>The ID of the service that you want to use for settings for the instance
|
|
3125
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that you want to use for settings for the instance. For
|
|
3126
|
+
* services created in a shared namespace, specify the service ARN. For more information about
|
|
3127
|
+
* shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
3128
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
2866
3129
|
* @public
|
|
2867
3130
|
*/
|
|
2868
3131
|
ServiceId: string | undefined;
|
|
@@ -2870,41 +3133,44 @@ export interface RegisterInstanceRequest {
|
|
|
2870
3133
|
* <p>An identifier that you want to associate with the instance. Note the following:</p>
|
|
2871
3134
|
* <ul>
|
|
2872
3135
|
* <li>
|
|
2873
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
2874
|
-
*
|
|
2875
|
-
*
|
|
3136
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
3137
|
+
* <code>SRV</code> record, the value of <code>InstanceId</code> is automatically included as
|
|
3138
|
+
* part of the value for the <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 >
|
|
3139
|
+
* Type</a>.</p>
|
|
2876
3140
|
* </li>
|
|
2877
3141
|
* <li>
|
|
2878
3142
|
* <p>You can use this value to update an existing instance.</p>
|
|
2879
3143
|
* </li>
|
|
2880
3144
|
* <li>
|
|
2881
|
-
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
2882
|
-
* using the same service. </p>
|
|
3145
|
+
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
3146
|
+
* you register by using the same service. </p>
|
|
2883
3147
|
* </li>
|
|
2884
3148
|
* <li>
|
|
2885
|
-
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
2886
|
-
* existing DNS records, if any. If there's also an existing health check, Cloud Map
|
|
2887
|
-
* check and creates a new one. </p>
|
|
3149
|
+
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
3150
|
+
* updates the existing DNS records, if any. If there's also an existing health check, Cloud Map
|
|
3151
|
+
* deletes the old health check and creates a new one. </p>
|
|
2888
3152
|
* <note>
|
|
2889
|
-
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
2890
|
-
*
|
|
3153
|
+
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
3154
|
+
* submit a <code>ListHealthChecks</code> request, for example.</p>
|
|
2891
3155
|
* </note>
|
|
2892
3156
|
* </li>
|
|
2893
3157
|
* </ul>
|
|
2894
3158
|
* <note>
|
|
2895
|
-
* <p>Do not include sensitive information in <code>InstanceId</code> if the namespace is
|
|
2896
|
-
* DNS queries and any <code>Type</code> member of <code>DnsRecord</code>
|
|
2897
|
-
*
|
|
3159
|
+
* <p>Do not include sensitive information in <code>InstanceId</code> if the namespace is
|
|
3160
|
+
* discoverable by public DNS queries and any <code>Type</code> member of <code>DnsRecord</code>
|
|
3161
|
+
* for the service contains <code>SRV</code> because the <code>InstanceId</code> is discoverable by
|
|
3162
|
+
* public DNS queries.</p>
|
|
2898
3163
|
* </note>
|
|
2899
3164
|
* @public
|
|
2900
3165
|
*/
|
|
2901
3166
|
InstanceId: string | undefined;
|
|
2902
3167
|
/**
|
|
2903
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
2904
|
-
*
|
|
2905
|
-
*
|
|
2906
|
-
*
|
|
2907
|
-
* unique string (for example, a
|
|
3168
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
3169
|
+
* <code>RegisterInstance</code> requests to be retried without the risk of executing the operation
|
|
3170
|
+
* twice. You must use a unique <code>CreatorRequestId</code> string every time you submit a
|
|
3171
|
+
* <code>RegisterInstance</code> request if you're registering additional instances for the same
|
|
3172
|
+
* namespace and service. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
3173
|
+
* date/time stamp).</p>
|
|
2908
3174
|
* @public
|
|
2909
3175
|
*/
|
|
2910
3176
|
CreatorRequestId?: string | undefined;
|
|
@@ -2920,42 +3186,42 @@ export interface RegisterInstanceRequest {
|
|
|
2920
3186
|
* </li>
|
|
2921
3187
|
* </ul>
|
|
2922
3188
|
* <important>
|
|
2923
|
-
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by
|
|
2924
|
-
* queries.</p>
|
|
3189
|
+
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by
|
|
3190
|
+
* public DNS queries.</p>
|
|
2925
3191
|
* </important>
|
|
2926
3192
|
* <p>The following are the supported attribute keys.</p>
|
|
2927
3193
|
* <dl>
|
|
2928
3194
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
2929
3195
|
* <dd>
|
|
2930
|
-
* <p>If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an
|
|
2931
|
-
* balancer, specify the DNS name that's associated with the load balancer. For
|
|
2932
|
-
* DNS name, see "DNSName" in the topic <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html">AliasTarget</a> in the
|
|
2933
|
-
* <i>Route 53 API Reference</i>.</p>
|
|
3196
|
+
* <p>If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an
|
|
3197
|
+
* Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For
|
|
3198
|
+
* information about how to get the DNS name, see "DNSName" in the topic <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html">AliasTarget</a> in the <i>Route 53 API Reference</i>.</p>
|
|
2934
3199
|
* <p>Note the following:</p>
|
|
2935
3200
|
* <ul>
|
|
2936
3201
|
* <li>
|
|
2937
|
-
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
2938
|
-
* an <code>A</code> record, an <code>AAAA</code> record, or both.</p>
|
|
3202
|
+
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
3203
|
+
* include settings for an <code>A</code> record, an <code>AAAA</code> record, or both.</p>
|
|
2939
3204
|
* </li>
|
|
2940
3205
|
* <li>
|
|
2941
|
-
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
2942
|
-
*
|
|
3206
|
+
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
3207
|
+
* <code>RoutingPolicy</code> must be <code>WEIGHTED</code>.</p>
|
|
2943
3208
|
* </li>
|
|
2944
3209
|
* <li>
|
|
2945
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
2946
|
-
*
|
|
2947
|
-
* alias record.</p>
|
|
3210
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
3211
|
+
* <code>HealthCheckConfig</code> settings, Cloud Map will create the Route 53 health check, but
|
|
3212
|
+
* it doesn't associate the health check with the alias record.</p>
|
|
2948
3213
|
* </li>
|
|
2949
3214
|
* <li>
|
|
2950
|
-
* <p>Cloud Map currently doesn't support creating alias records that route traffic to
|
|
2951
|
-
*
|
|
3215
|
+
* <p>Cloud Map currently doesn't support creating alias records that route traffic to
|
|
3216
|
+
* Amazon Web Services resources other than Elastic Load Balancing load balancers.</p>
|
|
2952
3217
|
* </li>
|
|
2953
3218
|
* <li>
|
|
2954
|
-
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
2955
|
-
*
|
|
3219
|
+
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
3220
|
+
* any of the <code>AWS_INSTANCE</code> attributes.</p>
|
|
2956
3221
|
* </li>
|
|
2957
3222
|
* <li>
|
|
2958
|
-
* <p>The <code>AWS_ALIAS_DNS_NAME</code> is not supported in the GovCloud (US)
|
|
3223
|
+
* <p>The <code>AWS_ALIAS_DNS_NAME</code> is not supported in the GovCloud (US)
|
|
3224
|
+
* Regions.</p>
|
|
2959
3225
|
* </li>
|
|
2960
3226
|
* </ul>
|
|
2961
3227
|
* </dd>
|
|
@@ -2963,56 +3229,61 @@ export interface RegisterInstanceRequest {
|
|
|
2963
3229
|
* <dd>
|
|
2964
3230
|
* <p>
|
|
2965
3231
|
* <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
|
-
* is <code>AWS_INIT_HEALTH_STATUS</code>. When the
|
|
2968
|
-
*
|
|
3232
|
+
* <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the only other attribute that
|
|
3233
|
+
* can be specified is <code>AWS_INIT_HEALTH_STATUS</code>. When the
|
|
3234
|
+
* <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the
|
|
3235
|
+
* <code>AWS_INSTANCE_IPV4</code> attribute will be filled out with the primary private IPv4
|
|
2969
3236
|
* address.</p>
|
|
2970
3237
|
* </dd>
|
|
2971
3238
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
2972
3239
|
* <dd>
|
|
2973
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
2974
|
-
*
|
|
2975
|
-
*
|
|
3240
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
3241
|
+
* optionally use <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom
|
|
3242
|
+
* health check, <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
2976
3243
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
2977
3244
|
* </dd>
|
|
2978
3245
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
2979
3246
|
* <dd>
|
|
2980
|
-
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
2981
|
-
* to return in response to DNS queries (for example,
|
|
2982
|
-
*
|
|
2983
|
-
*
|
|
3247
|
+
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
3248
|
+
* you want Route 53 to return in response to DNS queries (for example,
|
|
3249
|
+
* <code>example.com</code>).</p>
|
|
3250
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
3251
|
+
* settings for an <code>CNAME</code> record.</p>
|
|
2984
3252
|
* </dd>
|
|
2985
3253
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
2986
3254
|
* <dd>
|
|
2987
|
-
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
2988
|
-
* return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
2989
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
2990
|
-
*
|
|
2991
|
-
*
|
|
3255
|
+
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
3256
|
+
* want Route 53 to return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
3257
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
3258
|
+
* settings for an <code>A</code> record. If the service includes settings for an
|
|
3259
|
+
* <code>SRV</code> record, you must specify a value for <code>AWS_INSTANCE_IPV4</code>,
|
|
3260
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
2992
3261
|
* </dd>
|
|
2993
3262
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
2994
3263
|
* <dd>
|
|
2995
|
-
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
2996
|
-
* to return in response to DNS queries (for example,
|
|
2997
|
-
*
|
|
2998
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
2999
|
-
*
|
|
3000
|
-
*
|
|
3264
|
+
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
3265
|
+
* you want Route 53 to return in response to DNS queries (for example,
|
|
3266
|
+
* <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
3267
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
3268
|
+
* settings for an <code>AAAA</code> record. If the service includes settings for an
|
|
3269
|
+
* <code>SRV</code> record, you must specify a value for <code>AWS_INSTANCE_IPV4</code>,
|
|
3270
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
3001
3271
|
* </dd>
|
|
3002
3272
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
3003
3273
|
* <dd>
|
|
3004
|
-
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to
|
|
3005
|
-
* port.</p>
|
|
3006
|
-
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
3007
|
-
* send requests to. </p>
|
|
3008
|
-
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
3009
|
-
* when you created the service.</p>
|
|
3274
|
+
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to
|
|
3275
|
+
* return for the port.</p>
|
|
3276
|
+
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
3277
|
+
* want Route 53 to send requests to. </p>
|
|
3278
|
+
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
3279
|
+
* Route 53 health check when you created the service.</p>
|
|
3010
3280
|
* </dd>
|
|
3011
3281
|
* <dt>Custom attributes</dt>
|
|
3012
3282
|
* <dd>
|
|
3013
|
-
* <p>You can add up to 30 custom attributes. For each key-value pair, the maximum length of
|
|
3014
|
-
* name is 255 characters, and the maximum length of the attribute value is 1,024
|
|
3015
|
-
* all provided attributes (sum of all keys and values) must not
|
|
3283
|
+
* <p>You can add up to 30 custom attributes. For each key-value pair, the maximum length of
|
|
3284
|
+
* the attribute name is 255 characters, and the maximum length of the attribute value is 1,024
|
|
3285
|
+
* characters. The total size of all provided attributes (sum of all keys and values) must not
|
|
3286
|
+
* exceed 5,000 characters.</p>
|
|
3016
3287
|
* </dd>
|
|
3017
3288
|
* </dl>
|
|
3018
3289
|
* @public
|
|
@@ -3040,8 +3311,8 @@ export interface TagResourceRequest {
|
|
|
3040
3311
|
*/
|
|
3041
3312
|
ResourceARN: string | undefined;
|
|
3042
3313
|
/**
|
|
3043
|
-
* <p>The tags to add to the specified resource. Specifying the tag key is required. You can set
|
|
3044
|
-
* tag to an empty string, but you can't set the value of a tag to null.</p>
|
|
3314
|
+
* <p>The tags to add to the specified resource. Specifying the tag key is required. You can set
|
|
3315
|
+
* the value of a tag to an empty string, but you can't set the value of a tag to null.</p>
|
|
3045
3316
|
* @public
|
|
3046
3317
|
*/
|
|
3047
3318
|
Tags: Tag[] | undefined;
|
|
@@ -3076,22 +3347,20 @@ export interface UntagResourceResponse {
|
|
|
3076
3347
|
*/
|
|
3077
3348
|
export interface UpdateHttpNamespaceRequest {
|
|
3078
3349
|
/**
|
|
3079
|
-
* <p>The ID of the namespace that you
|
|
3080
|
-
* want to update.</p>
|
|
3350
|
+
* <p>The ID or Amazon Resource Name (ARN) of the namespace that you want to update.</p>
|
|
3081
3351
|
* @public
|
|
3082
3352
|
*/
|
|
3083
3353
|
Id: string | undefined;
|
|
3084
3354
|
/**
|
|
3085
|
-
* <p>A unique string that identifies the
|
|
3086
|
-
*
|
|
3087
|
-
*
|
|
3355
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
3356
|
+
* <code>UpdateHttpNamespace</code> requests to be retried without the risk of running the
|
|
3357
|
+
* operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
|
|
3088
3358
|
* date/timestamp).</p>
|
|
3089
3359
|
* @public
|
|
3090
3360
|
*/
|
|
3091
3361
|
UpdaterRequestId?: string | undefined;
|
|
3092
3362
|
/**
|
|
3093
|
-
* <p>Updated properties for the the HTTP
|
|
3094
|
-
* namespace.</p>
|
|
3363
|
+
* <p>Updated properties for the the HTTP namespace.</p>
|
|
3095
3364
|
* @public
|
|
3096
3365
|
*/
|
|
3097
3366
|
Namespace: HttpNamespaceChange | undefined;
|
|
@@ -3112,8 +3381,10 @@ export interface UpdateHttpNamespaceResponse {
|
|
|
3112
3381
|
*/
|
|
3113
3382
|
export interface UpdateInstanceCustomHealthStatusRequest {
|
|
3114
3383
|
/**
|
|
3115
|
-
* <p>The ID of the service that includes the configuration for the custom health
|
|
3116
|
-
* the status for
|
|
3384
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that includes the configuration for the custom health
|
|
3385
|
+
* check that you want to change the status for. For services created in a shared namespace, specify
|
|
3386
|
+
* the service ARN. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map
|
|
3387
|
+
* namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
|
|
3117
3388
|
* @public
|
|
3118
3389
|
*/
|
|
3119
3390
|
ServiceId: string | undefined;
|
|
@@ -3133,22 +3404,20 @@ export interface UpdateInstanceCustomHealthStatusRequest {
|
|
|
3133
3404
|
*/
|
|
3134
3405
|
export interface UpdatePrivateDnsNamespaceRequest {
|
|
3135
3406
|
/**
|
|
3136
|
-
* <p>The ID of the namespace that you
|
|
3137
|
-
* want to update.</p>
|
|
3407
|
+
* <p>The ID or Amazon Resource Name (ARN) of the namespace that you want to update.</p>
|
|
3138
3408
|
* @public
|
|
3139
3409
|
*/
|
|
3140
3410
|
Id: string | undefined;
|
|
3141
3411
|
/**
|
|
3142
|
-
* <p>A unique string that identifies the
|
|
3143
|
-
*
|
|
3144
|
-
*
|
|
3412
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
3413
|
+
* <code>UpdatePrivateDnsNamespace</code> requests to be retried without the risk of running the
|
|
3414
|
+
* operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
|
|
3145
3415
|
* date/timestamp).</p>
|
|
3146
3416
|
* @public
|
|
3147
3417
|
*/
|
|
3148
3418
|
UpdaterRequestId?: string | undefined;
|
|
3149
3419
|
/**
|
|
3150
|
-
* <p>Updated properties for the private
|
|
3151
|
-
* DNS namespace.</p>
|
|
3420
|
+
* <p>Updated properties for the private DNS namespace.</p>
|
|
3152
3421
|
* @public
|
|
3153
3422
|
*/
|
|
3154
3423
|
Namespace: PrivateDnsNamespaceChange | undefined;
|
|
@@ -3169,22 +3438,20 @@ export interface UpdatePrivateDnsNamespaceResponse {
|
|
|
3169
3438
|
*/
|
|
3170
3439
|
export interface UpdatePublicDnsNamespaceRequest {
|
|
3171
3440
|
/**
|
|
3172
|
-
* <p>The ID of the namespace being
|
|
3173
|
-
* updated.</p>
|
|
3441
|
+
* <p>The ID or Amazon Resource Name (ARN) of the namespace being updated.</p>
|
|
3174
3442
|
* @public
|
|
3175
3443
|
*/
|
|
3176
3444
|
Id: string | undefined;
|
|
3177
3445
|
/**
|
|
3178
|
-
* <p>A unique string that identifies the
|
|
3179
|
-
*
|
|
3180
|
-
*
|
|
3446
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
3447
|
+
* <code>UpdatePublicDnsNamespace</code> requests to be retried without the risk of running the
|
|
3448
|
+
* operation twice. <code>UpdaterRequestId</code> can be any unique string (for example, a
|
|
3181
3449
|
* date/timestamp).</p>
|
|
3182
3450
|
* @public
|
|
3183
3451
|
*/
|
|
3184
3452
|
UpdaterRequestId?: string | undefined;
|
|
3185
3453
|
/**
|
|
3186
|
-
* <p>Updated properties for the public
|
|
3187
|
-
* DNS namespace.</p>
|
|
3454
|
+
* <p>Updated properties for the public DNS namespace.</p>
|
|
3188
3455
|
* @public
|
|
3189
3456
|
*/
|
|
3190
3457
|
Namespace: PublicDnsNamespaceChange | undefined;
|
|
@@ -3211,16 +3478,16 @@ export interface ServiceChange {
|
|
|
3211
3478
|
*/
|
|
3212
3479
|
Description?: string | undefined;
|
|
3213
3480
|
/**
|
|
3214
|
-
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
|
|
3215
|
-
* instance.</p>
|
|
3481
|
+
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
|
|
3482
|
+
* an instance.</p>
|
|
3216
3483
|
* @public
|
|
3217
3484
|
*/
|
|
3218
3485
|
DnsConfig?: DnsConfigChange | undefined;
|
|
3219
3486
|
/**
|
|
3220
3487
|
* <p>
|
|
3221
|
-
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
3222
|
-
* specify settings for a health check, Cloud Map associates the health check with
|
|
3223
|
-
*
|
|
3488
|
+
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
3489
|
+
* check. If you specify settings for a health check, Cloud Map associates the health check with
|
|
3490
|
+
* the records that you specify in <code>DnsConfig</code>.</p>
|
|
3224
3491
|
* @public
|
|
3225
3492
|
*/
|
|
3226
3493
|
HealthCheckConfig?: HealthCheckConfig | undefined;
|
|
@@ -3230,12 +3497,17 @@ export interface ServiceChange {
|
|
|
3230
3497
|
*/
|
|
3231
3498
|
export interface UpdateServiceRequest {
|
|
3232
3499
|
/**
|
|
3233
|
-
* <p>The ID of the service that you want to update
|
|
3500
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that you want to update. If the namespace associated with
|
|
3501
|
+
* the service is shared with your Amazon Web Services account, specify the service ARN. For more information
|
|
3502
|
+
* about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the
|
|
3503
|
+
* <i>Cloud Map Developer Guide</i>
|
|
3504
|
+
* </p>
|
|
3234
3505
|
* @public
|
|
3235
3506
|
*/
|
|
3236
3507
|
Id: string | undefined;
|
|
3237
3508
|
/**
|
|
3238
|
-
* <p>A complex type that contains the new settings for the service. You can specify a maximum of
|
|
3509
|
+
* <p>A complex type that contains the new settings for the service. You can specify a maximum of
|
|
3510
|
+
* 30 attributes (key-value pairs).</p>
|
|
3239
3511
|
* @public
|
|
3240
3512
|
*/
|
|
3241
3513
|
Service: ServiceChange | undefined;
|
|
@@ -3252,7 +3524,8 @@ export interface UpdateServiceResponse {
|
|
|
3252
3524
|
OperationId?: string | undefined;
|
|
3253
3525
|
}
|
|
3254
3526
|
/**
|
|
3255
|
-
* <p>The attribute can't be added to the service because you've exceeded the quota for the number
|
|
3527
|
+
* <p>The attribute can't be added to the service because you've exceeded the quota for the number
|
|
3528
|
+
* of attributes you can add to a service.</p>
|
|
3256
3529
|
* @public
|
|
3257
3530
|
*/
|
|
3258
3531
|
export declare class ServiceAttributesLimitExceededException extends __BaseException {
|
|
@@ -3269,7 +3542,8 @@ export declare class ServiceAttributesLimitExceededException extends __BaseExcep
|
|
|
3269
3542
|
*/
|
|
3270
3543
|
export interface UpdateServiceAttributesRequest {
|
|
3271
3544
|
/**
|
|
3272
|
-
* <p>The ID of the service that you want to update
|
|
3545
|
+
* <p>The ID or Amazon Resource Name (ARN) of the service that you want to update. For services created in a
|
|
3546
|
+
* namespace shared with your Amazon Web Services account, specify the service ARN.</p>
|
|
3273
3547
|
* @public
|
|
3274
3548
|
*/
|
|
3275
3549
|
ServiceId: string | undefined;
|