@aws-sdk/client-servicediscovery 3.190.0 → 3.192.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/CHANGELOG.md +22 -0
- package/README.md +6 -5
- package/dist-cjs/ServiceDiscoveryClient.js +11 -8
- package/dist-cjs/commands/CreateHttpNamespaceCommand.js +10 -0
- package/dist-cjs/commands/CreatePrivateDnsNamespaceCommand.js +10 -0
- package/dist-cjs/commands/CreatePublicDnsNamespaceCommand.js +10 -0
- package/dist-cjs/commands/CreateServiceCommand.js +10 -0
- package/dist-cjs/commands/DeleteNamespaceCommand.js +10 -0
- package/dist-cjs/commands/DeleteServiceCommand.js +10 -0
- package/dist-cjs/commands/DeregisterInstanceCommand.js +10 -0
- package/dist-cjs/commands/DiscoverInstancesCommand.js +10 -0
- package/dist-cjs/commands/GetInstanceCommand.js +10 -0
- package/dist-cjs/commands/GetInstancesHealthStatusCommand.js +10 -0
- package/dist-cjs/commands/GetNamespaceCommand.js +10 -0
- package/dist-cjs/commands/GetOperationCommand.js +10 -0
- package/dist-cjs/commands/GetServiceCommand.js +10 -0
- package/dist-cjs/commands/ListInstancesCommand.js +10 -0
- package/dist-cjs/commands/ListNamespacesCommand.js +10 -0
- package/dist-cjs/commands/ListOperationsCommand.js +10 -0
- package/dist-cjs/commands/ListServicesCommand.js +10 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +10 -0
- package/dist-cjs/commands/RegisterInstanceCommand.js +10 -0
- package/dist-cjs/commands/TagResourceCommand.js +10 -0
- package/dist-cjs/commands/UntagResourceCommand.js +10 -0
- package/dist-cjs/commands/UpdateHttpNamespaceCommand.js +10 -0
- package/dist-cjs/commands/UpdateInstanceCustomHealthStatusCommand.js +10 -0
- package/dist-cjs/commands/UpdatePrivateDnsNamespaceCommand.js +10 -0
- package/dist-cjs/commands/UpdatePublicDnsNamespaceCommand.js +10 -0
- package/dist-cjs/commands/UpdateServiceCommand.js +10 -0
- package/dist-cjs/endpoint/EndpointParameters.js +13 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +356 -0
- package/dist-cjs/models/models_0.js +3 -0
- package/dist-cjs/runtimeConfig.shared.js +3 -3
- package/dist-es/ServiceDiscoveryClient.js +12 -9
- package/dist-es/commands/CreateHttpNamespaceCommand.js +10 -0
- package/dist-es/commands/CreatePrivateDnsNamespaceCommand.js +10 -0
- package/dist-es/commands/CreatePublicDnsNamespaceCommand.js +10 -0
- package/dist-es/commands/CreateServiceCommand.js +10 -0
- package/dist-es/commands/DeleteNamespaceCommand.js +10 -0
- package/dist-es/commands/DeleteServiceCommand.js +10 -0
- package/dist-es/commands/DeregisterInstanceCommand.js +10 -0
- package/dist-es/commands/DiscoverInstancesCommand.js +10 -0
- package/dist-es/commands/GetInstanceCommand.js +10 -0
- package/dist-es/commands/GetInstancesHealthStatusCommand.js +10 -0
- package/dist-es/commands/GetNamespaceCommand.js +10 -0
- package/dist-es/commands/GetOperationCommand.js +10 -0
- package/dist-es/commands/GetServiceCommand.js +10 -0
- package/dist-es/commands/ListInstancesCommand.js +10 -0
- package/dist-es/commands/ListNamespacesCommand.js +10 -0
- package/dist-es/commands/ListOperationsCommand.js +10 -0
- package/dist-es/commands/ListServicesCommand.js +10 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +10 -0
- package/dist-es/commands/RegisterInstanceCommand.js +10 -0
- package/dist-es/commands/TagResourceCommand.js +10 -0
- package/dist-es/commands/UntagResourceCommand.js +10 -0
- package/dist-es/commands/UpdateHttpNamespaceCommand.js +10 -0
- package/dist-es/commands/UpdateInstanceCustomHealthStatusCommand.js +10 -0
- package/dist-es/commands/UpdatePrivateDnsNamespaceCommand.js +10 -0
- package/dist-es/commands/UpdatePublicDnsNamespaceCommand.js +10 -0
- package/dist-es/commands/UpdateServiceCommand.js +10 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +353 -0
- package/dist-es/models/models_0.js +3 -0
- package/dist-es/runtimeConfig.shared.js +2 -2
- package/dist-types/ServiceDiscovery.d.ts +90 -71
- package/dist-types/ServiceDiscoveryClient.d.ts +12 -14
- package/dist-types/commands/CreateHttpNamespaceCommand.d.ts +6 -4
- package/dist-types/commands/CreatePrivateDnsNamespaceCommand.d.ts +9 -6
- package/dist-types/commands/CreatePublicDnsNamespaceCommand.d.ts +13 -6
- package/dist-types/commands/CreateServiceCommand.d.ts +9 -6
- package/dist-types/commands/DeleteNamespaceCommand.d.ts +4 -2
- package/dist-types/commands/DeleteServiceCommand.d.ts +4 -2
- package/dist-types/commands/DeregisterInstanceCommand.d.ts +4 -2
- package/dist-types/commands/DiscoverInstancesCommand.d.ts +5 -3
- package/dist-types/commands/GetInstanceCommand.d.ts +2 -0
- package/dist-types/commands/GetInstancesHealthStatusCommand.d.ts +7 -4
- package/dist-types/commands/GetNamespaceCommand.d.ts +2 -0
- package/dist-types/commands/GetOperationCommand.d.ts +2 -0
- package/dist-types/commands/GetServiceCommand.d.ts +2 -0
- package/dist-types/commands/ListInstancesCommand.d.ts +4 -1
- package/dist-types/commands/ListNamespacesCommand.d.ts +3 -1
- package/dist-types/commands/ListOperationsCommand.d.ts +2 -0
- package/dist-types/commands/ListServicesCommand.d.ts +4 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -0
- package/dist-types/commands/RegisterInstanceCommand.d.ts +23 -17
- package/dist-types/commands/TagResourceCommand.d.ts +2 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -0
- package/dist-types/commands/UpdateHttpNamespaceCommand.d.ts +2 -0
- package/dist-types/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +8 -4
- package/dist-types/commands/UpdatePrivateDnsNamespaceCommand.d.ts +2 -0
- package/dist-types/commands/UpdatePublicDnsNamespaceCommand.d.ts +2 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +11 -7
- package/dist-types/endpoint/EndpointParameters.d.ts +19 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +811 -651
- package/dist-types/runtimeConfig.browser.d.ts +4 -2
- package/dist-types/runtimeConfig.d.ts +4 -2
- package/dist-types/runtimeConfig.native.d.ts +4 -2
- package/dist-types/runtimeConfig.shared.d.ts +3 -1
- package/dist-types/ts3.4/ServiceDiscoveryClient.d.ts +15 -8
- package/dist-types/ts3.4/commands/CreateHttpNamespaceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreatePrivateDnsNamespaceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreatePublicDnsNamespaceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreateServiceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeleteNamespaceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeleteServiceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DeregisterInstanceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/DiscoverInstancesCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/GetInstanceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/GetInstancesHealthStatusCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/GetNamespaceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/GetOperationCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/GetServiceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListInstancesCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListNamespacesCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListOperationsCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListServicesCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/RegisterInstanceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdateHttpNamespaceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdateInstanceCustomHealthStatusCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdatePrivateDnsNamespaceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdatePublicDnsNamespaceCommand.d.ts +2 -0
- package/dist-types/ts3.4/commands/UpdateServiceCommand.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +26 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +3 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +14 -4
- package/dist-types/ts3.4/runtimeConfig.d.ts +14 -4
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +14 -3
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +6 -1
- package/package.json +4 -3
- package/dist-cjs/endpoints.js +0 -203
- package/dist-es/endpoints.js +0 -199
- package/dist-types/endpoints.d.ts +0 -2
- package/dist-types/ts3.4/endpoints.d.ts +0 -2
|
@@ -9,8 +9,8 @@ export interface Tag {
|
|
|
9
9
|
*/
|
|
10
10
|
Key: string | undefined;
|
|
11
11
|
/**
|
|
12
|
-
* <p>The string value that's associated with the key of the tag. You can set the value of a tag
|
|
13
|
-
* but you can't set the value of a tag to null.</p>
|
|
12
|
+
* <p>The string value that's associated with the key of the tag. You can set the value of a tag
|
|
13
|
+
* to an empty string, but you can't set the value of a tag to null.</p>
|
|
14
14
|
*/
|
|
15
15
|
Value: string | undefined;
|
|
16
16
|
}
|
|
@@ -20,9 +20,10 @@ export interface CreateHttpNamespaceRequest {
|
|
|
20
20
|
*/
|
|
21
21
|
Name: string | undefined;
|
|
22
22
|
/**
|
|
23
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
24
|
-
*
|
|
25
|
-
* (for example, a date/time
|
|
23
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
24
|
+
* <code>CreateHttpNamespace</code> requests to be retried without the risk of running the
|
|
25
|
+
* operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a date/time
|
|
26
|
+
* stamp).</p>
|
|
26
27
|
*/
|
|
27
28
|
CreatorRequestId?: string;
|
|
28
29
|
/**
|
|
@@ -30,8 +31,8 @@ export interface CreateHttpNamespaceRequest {
|
|
|
30
31
|
*/
|
|
31
32
|
Description?: string;
|
|
32
33
|
/**
|
|
33
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
34
|
-
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
34
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
35
|
+
* define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
35
36
|
* characters in length.</p>
|
|
36
37
|
*/
|
|
37
38
|
Tags?: Tag[];
|
|
@@ -60,8 +61,9 @@ export declare class DuplicateRequest extends __BaseException {
|
|
|
60
61
|
constructor(opts: __ExceptionOptionType<DuplicateRequest, __BaseException>);
|
|
61
62
|
}
|
|
62
63
|
/**
|
|
63
|
-
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
64
|
-
* be outside the allowed range, or a string value might exceed length
|
|
64
|
+
* <p>One or more specified values aren't valid. For example, a required value might be missing, a
|
|
65
|
+
* numeric value might be outside the allowed range, or a string value might exceed length
|
|
66
|
+
* constraints.</p>
|
|
65
67
|
*/
|
|
66
68
|
export declare class InvalidInput extends __BaseException {
|
|
67
69
|
readonly name: "InvalidInput";
|
|
@@ -93,7 +95,8 @@ export declare class NamespaceAlreadyExists extends __BaseException {
|
|
|
93
95
|
constructor(opts: __ExceptionOptionType<NamespaceAlreadyExists, __BaseException>);
|
|
94
96
|
}
|
|
95
97
|
/**
|
|
96
|
-
* <p>The resource can't be created because you've reached the quota on the number of
|
|
98
|
+
* <p>The resource can't be created because you've reached the quota on the number of
|
|
99
|
+
* resources.</p>
|
|
97
100
|
*/
|
|
98
101
|
export declare class ResourceLimitExceeded extends __BaseException {
|
|
99
102
|
readonly name: "ResourceLimitExceeded";
|
|
@@ -105,8 +108,8 @@ export declare class ResourceLimitExceeded extends __BaseException {
|
|
|
105
108
|
constructor(opts: __ExceptionOptionType<ResourceLimitExceeded, __BaseException>);
|
|
106
109
|
}
|
|
107
110
|
/**
|
|
108
|
-
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
109
|
-
* is 50.</p>
|
|
111
|
+
* <p>The list of tags on the resource is over the quota. The maximum number of tags that can be
|
|
112
|
+
* applied to a resource is 50.</p>
|
|
110
113
|
*/
|
|
111
114
|
export declare class TooManyTagsException extends __BaseException {
|
|
112
115
|
readonly name: "TooManyTagsException";
|
|
@@ -122,48 +125,51 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
122
125
|
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
|
|
123
126
|
}
|
|
124
127
|
/**
|
|
125
|
-
* <p>Start of Authority
|
|
126
|
-
* public or private DNS namespace.</p>
|
|
128
|
+
* <p>Start of Authority
|
|
129
|
+
* (SOA) properties for a public or private DNS namespace.</p>
|
|
127
130
|
*/
|
|
128
131
|
export interface SOA {
|
|
129
132
|
/**
|
|
130
|
-
* <p>The time to live
|
|
131
|
-
* negative caching.</p>
|
|
133
|
+
* <p>The time to live
|
|
134
|
+
* (TTL) for purposes of negative caching.</p>
|
|
132
135
|
*/
|
|
133
136
|
TTL: number | undefined;
|
|
134
137
|
}
|
|
135
138
|
/**
|
|
136
|
-
* <p>DNS properties for
|
|
137
|
-
* namespace.</p>
|
|
139
|
+
* <p>DNS properties for
|
|
140
|
+
* the private DNS namespace.</p>
|
|
138
141
|
*/
|
|
139
142
|
export interface PrivateDnsPropertiesMutable {
|
|
140
143
|
/**
|
|
141
|
-
* <p>Fields for the Start
|
|
142
|
-
* record for the hosted zone for the private DNS
|
|
144
|
+
* <p>Fields for the Start
|
|
145
|
+
* of Authority (SOA) record for the hosted zone for the private DNS
|
|
146
|
+
* namespace.</p>
|
|
143
147
|
*/
|
|
144
148
|
SOA: SOA | undefined;
|
|
145
149
|
}
|
|
146
150
|
/**
|
|
147
|
-
* <p>DNS properties for
|
|
148
|
-
* namespace.</p>
|
|
151
|
+
* <p>DNS properties for
|
|
152
|
+
* the private DNS namespace.</p>
|
|
149
153
|
*/
|
|
150
154
|
export interface PrivateDnsNamespaceProperties {
|
|
151
155
|
/**
|
|
152
|
-
* <p>DNS properties for
|
|
153
|
-
* namespace.</p>
|
|
156
|
+
* <p>DNS properties for
|
|
157
|
+
* the private DNS namespace.</p>
|
|
154
158
|
*/
|
|
155
159
|
DnsProperties: PrivateDnsPropertiesMutable | undefined;
|
|
156
160
|
}
|
|
157
161
|
export interface CreatePrivateDnsNamespaceRequest {
|
|
158
162
|
/**
|
|
159
|
-
* <p>The name that you want to assign to this namespace. When you create a private DNS namespace,
|
|
160
|
-
* automatically creates an Amazon Route
|
|
163
|
+
* <p>The name that you want to assign to this namespace. When you create a private DNS namespace,
|
|
164
|
+
* Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the
|
|
165
|
+
* namespace.</p>
|
|
161
166
|
*/
|
|
162
167
|
Name: string | undefined;
|
|
163
168
|
/**
|
|
164
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
165
|
-
*
|
|
166
|
-
* unique string (for example, a
|
|
169
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
170
|
+
* <code>CreatePrivateDnsNamespace</code> requests to be retried without the risk of running the
|
|
171
|
+
* operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
172
|
+
* date/timestamp).</p>
|
|
167
173
|
*/
|
|
168
174
|
CreatorRequestId?: string;
|
|
169
175
|
/**
|
|
@@ -175,14 +181,14 @@ export interface CreatePrivateDnsNamespaceRequest {
|
|
|
175
181
|
*/
|
|
176
182
|
Vpc: string | undefined;
|
|
177
183
|
/**
|
|
178
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
179
|
-
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
184
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
185
|
+
* define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
180
186
|
* characters in length.</p>
|
|
181
187
|
*/
|
|
182
188
|
Tags?: Tag[];
|
|
183
189
|
/**
|
|
184
|
-
* <p>Properties for the
|
|
185
|
-
* namespace.</p>
|
|
190
|
+
* <p>Properties for the
|
|
191
|
+
* private DNS namespace.</p>
|
|
186
192
|
*/
|
|
187
193
|
Properties?: PrivateDnsNamespaceProperties;
|
|
188
194
|
}
|
|
@@ -194,36 +200,41 @@ export interface CreatePrivateDnsNamespaceResponse {
|
|
|
194
200
|
OperationId?: string;
|
|
195
201
|
}
|
|
196
202
|
/**
|
|
197
|
-
* <p>DNS properties for
|
|
198
|
-
* namespace.</p>
|
|
203
|
+
* <p>DNS properties for
|
|
204
|
+
* the public DNS namespace.</p>
|
|
199
205
|
*/
|
|
200
206
|
export interface PublicDnsPropertiesMutable {
|
|
201
207
|
/**
|
|
202
|
-
* <p>Start of Authority
|
|
203
|
-
* hosted zone for the public DNS namespace.</p>
|
|
208
|
+
* <p>Start of Authority
|
|
209
|
+
* (SOA) record for the hosted zone for the public DNS namespace.</p>
|
|
204
210
|
*/
|
|
205
211
|
SOA: SOA | undefined;
|
|
206
212
|
}
|
|
207
213
|
/**
|
|
208
|
-
* <p>DNS properties for
|
|
209
|
-
* namespace.</p>
|
|
214
|
+
* <p>DNS properties for
|
|
215
|
+
* the public DNS namespace.</p>
|
|
210
216
|
*/
|
|
211
217
|
export interface PublicDnsNamespaceProperties {
|
|
212
218
|
/**
|
|
213
|
-
* <p>DNS properties for
|
|
214
|
-
* namespace.</p>
|
|
219
|
+
* <p>DNS properties for
|
|
220
|
+
* the public DNS namespace.</p>
|
|
215
221
|
*/
|
|
216
222
|
DnsProperties: PublicDnsPropertiesMutable | undefined;
|
|
217
223
|
}
|
|
218
224
|
export interface CreatePublicDnsNamespaceRequest {
|
|
219
225
|
/**
|
|
220
226
|
* <p>The name that you want to assign to this namespace.</p>
|
|
227
|
+
*
|
|
228
|
+
* <note>
|
|
229
|
+
* <p>Do not include sensitive information in the name. The name is publicly available using DNS queries.</p>
|
|
230
|
+
* </note>
|
|
221
231
|
*/
|
|
222
232
|
Name: string | undefined;
|
|
223
233
|
/**
|
|
224
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
225
|
-
*
|
|
226
|
-
* unique string (for example, a
|
|
234
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
235
|
+
* <code>CreatePublicDnsNamespace</code> requests to be retried without the risk of running the
|
|
236
|
+
* operation twice. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
237
|
+
* date/timestamp).</p>
|
|
227
238
|
*/
|
|
228
239
|
CreatorRequestId?: string;
|
|
229
240
|
/**
|
|
@@ -231,21 +242,21 @@ export interface CreatePublicDnsNamespaceRequest {
|
|
|
231
242
|
*/
|
|
232
243
|
Description?: string;
|
|
233
244
|
/**
|
|
234
|
-
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
235
|
-
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
245
|
+
* <p>The tags to add to the namespace. Each tag consists of a key and an optional value that you
|
|
246
|
+
* define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
236
247
|
* characters in length.</p>
|
|
237
248
|
*/
|
|
238
249
|
Tags?: Tag[];
|
|
239
250
|
/**
|
|
240
|
-
* <p>Properties for the
|
|
241
|
-
* namespace.</p>
|
|
251
|
+
* <p>Properties for the
|
|
252
|
+
* public DNS namespace.</p>
|
|
242
253
|
*/
|
|
243
254
|
Properties?: PublicDnsNamespaceProperties;
|
|
244
255
|
}
|
|
245
256
|
export interface CreatePublicDnsNamespaceResponse {
|
|
246
257
|
/**
|
|
247
|
-
* <p>A value that you can use to determine whether the request completed successfully. To get the
|
|
248
|
-
* operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
|
|
258
|
+
* <p>A value that you can use to determine whether the request completed successfully. To get the
|
|
259
|
+
* status of the operation, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html">GetOperation</a>.</p>
|
|
249
260
|
*/
|
|
250
261
|
OperationId?: string;
|
|
251
262
|
}
|
|
@@ -256,13 +267,14 @@ export declare enum RecordType {
|
|
|
256
267
|
SRV = "SRV"
|
|
257
268
|
}
|
|
258
269
|
/**
|
|
259
|
-
* <p>A complex type that contains information about the Route
|
|
260
|
-
* register an instance.</p>
|
|
270
|
+
* <p>A complex type that contains information about the Route 53 DNS records that you want
|
|
271
|
+
* Cloud Map to create when you register an instance.</p>
|
|
261
272
|
*/
|
|
262
273
|
export interface DnsRecord {
|
|
263
274
|
/**
|
|
264
|
-
* <p>The type of the resource, which indicates the type of value that Route
|
|
265
|
-
* can specify values for <code>Type</code> in the following
|
|
275
|
+
* <p>The type of the resource, which indicates the type of value that Route 53 returns in response
|
|
276
|
+
* to DNS queries. You can specify values for <code>Type</code> in the following
|
|
277
|
+
* combinations:</p>
|
|
266
278
|
* <ul>
|
|
267
279
|
* <li>
|
|
268
280
|
* <p>
|
|
@@ -302,61 +314,66 @@ export interface DnsRecord {
|
|
|
302
314
|
* </p>
|
|
303
315
|
* </li>
|
|
304
316
|
* </ul>
|
|
305
|
-
* <p>If you want Cloud Map to create a Route
|
|
306
|
-
* <code>AAAA</code> for <code>Type</code>.</p>
|
|
307
|
-
* <p>You specify other settings, such as the IP address for <code>A</code> and <code>AAAA</code>
|
|
308
|
-
* register an instance. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a>.</p>
|
|
317
|
+
* <p>If you want Cloud Map to create a Route 53 alias record when you register an instance, specify
|
|
318
|
+
* <code>A</code> or <code>AAAA</code> for <code>Type</code>.</p>
|
|
319
|
+
* <p>You specify other settings, such as the IP address for <code>A</code> and <code>AAAA</code>
|
|
320
|
+
* 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>
|
|
309
321
|
* <p>The following values are supported:</p>
|
|
310
322
|
* <dl>
|
|
311
323
|
* <dt>A</dt>
|
|
312
324
|
* <dd>
|
|
313
|
-
* <p>Route
|
|
325
|
+
* <p>Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.</p>
|
|
314
326
|
* </dd>
|
|
315
327
|
* <dt>AAAA</dt>
|
|
316
328
|
* <dd>
|
|
317
|
-
* <p>Route
|
|
329
|
+
* <p>Route 53 returns the IP address of the resource in IPv6 format, such as
|
|
318
330
|
* 2001:0db8:85a3:0000:0000:abcd:0001:2345.</p>
|
|
319
331
|
* </dd>
|
|
320
332
|
* <dt>CNAME</dt>
|
|
321
333
|
* <dd>
|
|
322
|
-
* <p>Route
|
|
334
|
+
* <p>Route 53 returns the domain name of the resource, such as www.example.com. Note the
|
|
335
|
+
* following:</p>
|
|
323
336
|
* <ul>
|
|
324
337
|
* <li>
|
|
325
|
-
* <p>You specify the domain name that you want to route traffic to when you register an
|
|
326
|
-
* 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>
|
|
338
|
+
* <p>You specify the domain name that you want to route traffic to when you register an
|
|
339
|
+
* 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>
|
|
327
340
|
* </li>
|
|
328
341
|
* <li>
|
|
329
|
-
* <p>You must specify <code>WEIGHTED</code> for the value of
|
|
342
|
+
* <p>You must specify <code>WEIGHTED</code> for the value of
|
|
343
|
+
* <code>RoutingPolicy</code>.</p>
|
|
330
344
|
* </li>
|
|
331
345
|
* <li>
|
|
332
346
|
* <p>You can't specify both <code>CNAME</code> for <code>Type</code> and settings for
|
|
333
|
-
* <code>HealthCheckConfig</code>. If you do, the request will fail with an
|
|
334
|
-
*
|
|
347
|
+
* <code>HealthCheckConfig</code>. If you do, the request will fail with an
|
|
348
|
+
* <code>InvalidInput</code> error.</p>
|
|
335
349
|
* </li>
|
|
336
350
|
* </ul>
|
|
337
351
|
* </dd>
|
|
338
352
|
* <dt>SRV</dt>
|
|
339
353
|
* <dd>
|
|
340
|
-
* <p>Route
|
|
341
|
-
* following values:</p>
|
|
354
|
+
* <p>Route 53 returns the value for an <code>SRV</code> record. The value for an <code>SRV</code>
|
|
355
|
+
* record uses the following values:</p>
|
|
342
356
|
* <p>
|
|
343
357
|
* <code>priority weight port service-hostname</code>
|
|
344
358
|
* </p>
|
|
345
359
|
* <p>Note the following about the values:</p>
|
|
346
360
|
* <ul>
|
|
347
361
|
* <li>
|
|
348
|
-
* <p>The values of <code>priority</code> and <code>weight</code> are both set to
|
|
349
|
-
*
|
|
362
|
+
* <p>The values of <code>priority</code> and <code>weight</code> are both set to
|
|
363
|
+
* <code>1</code> and can't be changed. </p>
|
|
350
364
|
* </li>
|
|
351
365
|
* <li>
|
|
352
|
-
* <p>The value of <code>port</code> comes from the value that you specify for the
|
|
353
|
-
*
|
|
366
|
+
* <p>The value of <code>port</code> comes from the value that you specify for the
|
|
367
|
+
* <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>
|
|
368
|
+
* request.</p>
|
|
354
369
|
* </li>
|
|
355
370
|
* <li>
|
|
356
|
-
* <p>The value of <code>service-hostname</code> is a concatenation of the following
|
|
371
|
+
* <p>The value of <code>service-hostname</code> is a concatenation of the following
|
|
372
|
+
* values:</p>
|
|
357
373
|
* <ul>
|
|
358
374
|
* <li>
|
|
359
|
-
* <p>The value that you specify for <code>InstanceId</code> when you register an
|
|
375
|
+
* <p>The value that you specify for <code>InstanceId</code> when you register an
|
|
376
|
+
* instance.</p>
|
|
360
377
|
* </li>
|
|
361
378
|
* <li>
|
|
362
379
|
* <p>The name of the service.</p>
|
|
@@ -365,9 +382,10 @@ export interface DnsRecord {
|
|
|
365
382
|
* <p>The name of the namespace. </p>
|
|
366
383
|
* </li>
|
|
367
384
|
* </ul>
|
|
368
|
-
* <p>For example, if the value of <code>InstanceId</code> is <code>test</code>, the name of
|
|
369
|
-
*
|
|
370
|
-
* <code>service-hostname</code> is the
|
|
385
|
+
* <p>For example, if the value of <code>InstanceId</code> is <code>test</code>, the name of
|
|
386
|
+
* the service is <code>backend</code>, and the name of the namespace is
|
|
387
|
+
* <code>example.com</code>, the value of <code>service-hostname</code> is the
|
|
388
|
+
* following:</p>
|
|
371
389
|
* <p>
|
|
372
390
|
* <code>test.backend.example.com</code>
|
|
373
391
|
* </p>
|
|
@@ -376,14 +394,16 @@ export interface DnsRecord {
|
|
|
376
394
|
* <p>If you specify settings for an <code>SRV</code> record, note the following:</p>
|
|
377
395
|
* <ul>
|
|
378
396
|
* <li>
|
|
379
|
-
* <p>If you specify values for <code>AWS_INSTANCE_IPV4</code>,
|
|
380
|
-
* <code>
|
|
381
|
-
*
|
|
397
|
+
* <p>If you specify values for <code>AWS_INSTANCE_IPV4</code>,
|
|
398
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both in the <code>RegisterInstance</code> request,
|
|
399
|
+
* Cloud Map automatically creates <code>A</code> and/or <code>AAAA</code> records that have
|
|
400
|
+
* the same name as the value of <code>service-hostname</code> in the <code>SRV</code> record.
|
|
382
401
|
* You can ignore these records.</p>
|
|
383
402
|
* </li>
|
|
384
403
|
* <li>
|
|
385
|
-
* <p>If you're using a system that requires a specific <code>SRV</code> format, such as
|
|
386
|
-
*
|
|
404
|
+
* <p>If you're using a system that requires a specific <code>SRV</code> format, such as
|
|
405
|
+
* 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
|
|
406
|
+
* about how to specify the correct name format.</p>
|
|
387
407
|
* </li>
|
|
388
408
|
* </ul>
|
|
389
409
|
* </dd>
|
|
@@ -391,12 +411,14 @@ export interface DnsRecord {
|
|
|
391
411
|
*/
|
|
392
412
|
Type: RecordType | string | undefined;
|
|
393
413
|
/**
|
|
394
|
-
* <p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this
|
|
414
|
+
* <p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this
|
|
415
|
+
* record.</p>
|
|
395
416
|
* <note>
|
|
396
|
-
* <p>Alias records don't include a TTL because Route
|
|
397
|
-
* traffic to. If you include the <code>AWS_ALIAS_DNS_NAME</code> attribute
|
|
398
|
-
*
|
|
399
|
-
*
|
|
417
|
+
* <p>Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an
|
|
418
|
+
* alias record routes traffic to. If you include the <code>AWS_ALIAS_DNS_NAME</code> attribute
|
|
419
|
+
* when you submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, the
|
|
420
|
+
* <code>TTL</code> value is ignored. Always specify a TTL for the service; you can use a service
|
|
421
|
+
* to register instances that create either alias or non-alias records.</p>
|
|
400
422
|
* </note>
|
|
401
423
|
*/
|
|
402
424
|
TTL: number | undefined;
|
|
@@ -406,58 +428,68 @@ export declare enum RoutingPolicy {
|
|
|
406
428
|
WEIGHTED = "WEIGHTED"
|
|
407
429
|
}
|
|
408
430
|
/**
|
|
409
|
-
* <p>A complex type that contains information about the Amazon Route
|
|
410
|
-
* you register an instance.</p>
|
|
431
|
+
* <p>A complex type that contains information about the Amazon Route 53 DNS records that you want
|
|
432
|
+
* Cloud Map to create when you register an instance.</p>
|
|
433
|
+
* <important>
|
|
434
|
+
* <p>The record types of a service can only be changed by deleting the service and recreating it
|
|
435
|
+
* with a new <code>Dnsconfig</code>.</p>
|
|
436
|
+
* </important>
|
|
411
437
|
*/
|
|
412
438
|
export interface DnsConfig {
|
|
413
439
|
/**
|
|
414
440
|
* @deprecated
|
|
415
441
|
*
|
|
416
|
-
* <p>
|
|
442
|
+
* <p>
|
|
443
|
+
* <i>Use
|
|
444
|
+
* NamespaceId in <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html">Service</a> instead.</i>
|
|
445
|
+
* </p>
|
|
446
|
+
* <p>The ID of the namespace to use for DNS configuration.</p>
|
|
417
447
|
*/
|
|
418
448
|
NamespaceId?: string;
|
|
419
449
|
/**
|
|
420
|
-
* <p>The routing policy that you want to apply to all Route
|
|
421
|
-
* instance and specify this service.</p>
|
|
450
|
+
* <p>The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates
|
|
451
|
+
* when you register an instance and specify this service.</p>
|
|
422
452
|
* <note>
|
|
423
|
-
* <p>If you want to use this service to register instances that create alias records, specify
|
|
424
|
-
*
|
|
453
|
+
* <p>If you want to use this service to register instances that create alias records, specify
|
|
454
|
+
* <code>WEIGHTED</code> for the routing policy.</p>
|
|
425
455
|
* </note>
|
|
426
456
|
* <p>You can specify the following values:</p>
|
|
427
457
|
* <dl>
|
|
428
458
|
* <dt>MULTIVALUE</dt>
|
|
429
459
|
* <dd>
|
|
430
|
-
* <p>If you define a health check for the service and the health check is healthy, Route
|
|
431
|
-
* value for up to eight instances.</p>
|
|
432
|
-
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
433
|
-
* check. You use the service to register 10 instances. Route
|
|
434
|
-
* eight healthy instances. If fewer than eight instances are
|
|
435
|
-
* addresses for all of the healthy
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
460
|
+
* <p>If you define a health check for the service and the health check is healthy, Route 53
|
|
461
|
+
* returns the applicable value for up to eight instances.</p>
|
|
462
|
+
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
463
|
+
* record and a health check. You use the service to register 10 instances. Route 53 responds to DNS
|
|
464
|
+
* queries with IP addresses for up to eight healthy instances. If fewer than eight instances are
|
|
465
|
+
* healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy
|
|
466
|
+
* instances.</p>
|
|
467
|
+
* <p>If you don't define a health check for the service, Route 53 assumes that all instances are
|
|
468
|
+
* healthy and returns the values for up to eight instances.</p>
|
|
469
|
+
* <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
|
|
470
|
+
* Answer Routing</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
440
471
|
* </dd>
|
|
441
472
|
* <dt>WEIGHTED</dt>
|
|
442
473
|
* <dd>
|
|
443
|
-
* <p>Route
|
|
444
|
-
* registered using the same service. Currently, all records have the same
|
|
445
|
-
* traffic to any instances.</p>
|
|
446
|
-
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
447
|
-
* check. You use the service to register 10 instances. Route
|
|
448
|
-
*
|
|
449
|
-
* queries as if all of the
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
453
|
-
*
|
|
474
|
+
* <p>Route 53 returns the applicable value from one randomly selected instance from among the
|
|
475
|
+
* instances that you registered using the same service. Currently, all records have the same
|
|
476
|
+
* weight, so you can't route more or less traffic to any instances.</p>
|
|
477
|
+
* <p>For example, suppose that the service includes configurations for one <code>A</code>
|
|
478
|
+
* record and a health check. You use the service to register 10 instances. Route 53 responds to DNS
|
|
479
|
+
* queries with the IP address for one randomly selected instance from among the healthy
|
|
480
|
+
* instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the
|
|
481
|
+
* instances were healthy.</p>
|
|
482
|
+
* <p>If you don't define a health check for the service, Route 53 assumes that all instances are
|
|
483
|
+
* healthy and returns the applicable value for one randomly selected instance.</p>
|
|
484
|
+
* <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
|
|
485
|
+
* Routing</a> in the <i>Route 53 Developer Guide</i>.</p>
|
|
454
486
|
* </dd>
|
|
455
487
|
* </dl>
|
|
456
488
|
*/
|
|
457
489
|
RoutingPolicy?: RoutingPolicy | string;
|
|
458
490
|
/**
|
|
459
|
-
* <p>An array that contains one <code>DnsRecord</code> object for each Route
|
|
460
|
-
* create when you register an instance.</p>
|
|
491
|
+
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 DNS record that you
|
|
492
|
+
* want Cloud Map to create when you register an instance.</p>
|
|
461
493
|
*/
|
|
462
494
|
DnsRecords: DnsRecord[] | undefined;
|
|
463
495
|
}
|
|
@@ -468,69 +500,72 @@ export declare enum HealthCheckType {
|
|
|
468
500
|
}
|
|
469
501
|
/**
|
|
470
502
|
* <p>
|
|
471
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
472
|
-
* health check. If you specify settings for a health check, Cloud Map
|
|
473
|
-
* that you specify in <code>DnsConfig</code>.</p>
|
|
503
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
504
|
+
* settings for an optional health check. If you specify settings for a health check, Cloud Map
|
|
505
|
+
* associates the health check with the records that you specify in <code>DnsConfig</code>.</p>
|
|
474
506
|
* <important>
|
|
475
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
476
|
-
* <code>HealthCheckConfig</code> but not both.</p>
|
|
507
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
508
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
477
509
|
* </important>
|
|
478
|
-
* <p>Health checks are basic Route
|
|
479
|
-
* pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route
|
|
510
|
+
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For
|
|
511
|
+
* information about pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
|
|
480
512
|
* <p>Note the following about configuring health checks.</p>
|
|
481
513
|
* <dl>
|
|
482
514
|
* <dt>A and AAAA records</dt>
|
|
483
515
|
* <dd>
|
|
484
|
-
* <p>If <code>DnsConfig</code> includes configurations for both <code>A</code> and
|
|
485
|
-
*
|
|
486
|
-
*
|
|
487
|
-
*
|
|
516
|
+
* <p>If <code>DnsConfig</code> includes configurations for both <code>A</code> and
|
|
517
|
+
* <code>AAAA</code> records, Cloud Map creates a health check that uses the IPv4 address to
|
|
518
|
+
* check the health of the resource. If the endpoint tthat's specified by the IPv4 address is
|
|
519
|
+
* unhealthy, Route 53 considers both the <code>A</code> and <code>AAAA</code> records to be
|
|
520
|
+
* unhealthy. </p>
|
|
488
521
|
* </dd>
|
|
489
522
|
* <dt>CNAME records</dt>
|
|
490
523
|
* <dd>
|
|
491
|
-
* <p>You can't specify settings for <code>HealthCheckConfig</code> when the
|
|
492
|
-
* <code>CNAME</code> for the value of <code>Type</code>. If you
|
|
493
|
-
* fail with an <code>InvalidInput</code>
|
|
524
|
+
* <p>You can't specify settings for <code>HealthCheckConfig</code> when the
|
|
525
|
+
* <code>DNSConfig</code> includes <code>CNAME</code> for the value of <code>Type</code>. If you
|
|
526
|
+
* do, the <code>CreateService</code> request will fail with an <code>InvalidInput</code>
|
|
527
|
+
* error.</p>
|
|
494
528
|
* </dd>
|
|
495
529
|
* <dt>Request interval</dt>
|
|
496
530
|
* <dd>
|
|
497
|
-
* <p>A Route
|
|
498
|
-
* 30 seconds. On average, your endpoint receives a health check request
|
|
499
|
-
* checkers don't coordinate with one another.
|
|
500
|
-
* that's followed by a few
|
|
531
|
+
* <p>A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request
|
|
532
|
+
* to an endpoint every 30 seconds. On average, your endpoint receives a health check request
|
|
533
|
+
* about every two seconds. However, health checkers don't coordinate with one another.
|
|
534
|
+
* Therefore, you might sometimes see several requests in one second that's followed by a few
|
|
535
|
+
* seconds with no health checks at all.</p>
|
|
501
536
|
* </dd>
|
|
502
537
|
* <dt>Health checking regions</dt>
|
|
503
538
|
* <dd>
|
|
504
|
-
* <p>Health checkers perform checks from all Route
|
|
505
|
-
*
|
|
539
|
+
* <p>Health checkers perform checks from all Route 53 health-checking Regions. For a list of the
|
|
540
|
+
* current Regions, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions">Regions</a>.</p>
|
|
506
541
|
* </dd>
|
|
507
542
|
* <dt>Alias records</dt>
|
|
508
543
|
* <dd>
|
|
509
|
-
* <p>When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code>
|
|
510
|
-
* creates a Route
|
|
544
|
+
* <p>When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code>
|
|
545
|
+
* attribute, Cloud Map creates a Route 53 alias record. Note the following:</p>
|
|
511
546
|
* <ul>
|
|
512
547
|
* <li>
|
|
513
|
-
* <p>Route
|
|
514
|
-
*
|
|
515
|
-
* 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>
|
|
548
|
+
* <p>Route 53 automatically sets <code>EvaluateTargetHealth</code> to true for alias records.
|
|
549
|
+
* When <code>EvaluateTargetHealth</code> is true, the alias record inherits the health of the
|
|
550
|
+
* 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>
|
|
516
551
|
* </li>
|
|
517
552
|
* <li>
|
|
518
|
-
* <p>If you include <code>HealthCheckConfig</code> and then use the service to register an
|
|
519
|
-
* an alias record, Route
|
|
553
|
+
* <p>If you include <code>HealthCheckConfig</code> and then use the service to register an
|
|
554
|
+
* instance that creates an alias record, Route 53 doesn't create the health check.</p>
|
|
520
555
|
* </li>
|
|
521
556
|
* </ul>
|
|
522
557
|
* </dd>
|
|
523
558
|
* <dt>Charges for health checks</dt>
|
|
524
559
|
* <dd>
|
|
525
|
-
* <p>Health checks are basic Route
|
|
526
|
-
* health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route
|
|
560
|
+
* <p>Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For
|
|
561
|
+
* information about pricing for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
|
|
527
562
|
* </dd>
|
|
528
563
|
* </dl>
|
|
529
564
|
*/
|
|
530
565
|
export interface HealthCheckConfig {
|
|
531
566
|
/**
|
|
532
|
-
* <p>The type of health check that you want to create, which indicates how Route
|
|
533
|
-
* healthy.</p>
|
|
567
|
+
* <p>The type of health check that you want to create, which indicates how Route 53 determines
|
|
568
|
+
* whether an endpoint is healthy.</p>
|
|
534
569
|
* <important>
|
|
535
570
|
* <p>You can't change the value of <code>Type</code> after you create a health check.</p>
|
|
536
571
|
* </important>
|
|
@@ -538,64 +573,74 @@ export interface HealthCheckConfig {
|
|
|
538
573
|
* <ul>
|
|
539
574
|
* <li>
|
|
540
575
|
* <p>
|
|
541
|
-
* <b>HTTP</b>: Route
|
|
542
|
-
* an HTTP request and waits for an HTTP status code of 200 or greater
|
|
576
|
+
* <b>HTTP</b>: Route 53 tries to establish a TCP connection. If
|
|
577
|
+
* successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater
|
|
578
|
+
* and less than 400.</p>
|
|
543
579
|
* </li>
|
|
544
580
|
* <li>
|
|
545
581
|
* <p>
|
|
546
|
-
* <b>HTTPS</b>: Route
|
|
547
|
-
* submits an HTTPS request and waits for an HTTP status code of 200 or greater
|
|
582
|
+
* <b>HTTPS</b>: Route 53 tries to establish a TCP connection. If
|
|
583
|
+
* successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater
|
|
584
|
+
* and less than 400.</p>
|
|
548
585
|
* <important>
|
|
549
|
-
* <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS
|
|
586
|
+
* <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS
|
|
587
|
+
* v1.0 or later.</p>
|
|
550
588
|
* </important>
|
|
551
589
|
* </li>
|
|
552
590
|
* <li>
|
|
553
591
|
* <p>
|
|
554
|
-
* <b>TCP</b>: Route
|
|
592
|
+
* <b>TCP</b>: Route 53 tries to establish a TCP connection.</p>
|
|
555
593
|
* <p>If you specify <code>TCP</code> for <code>Type</code>, don't specify a value for
|
|
556
|
-
*
|
|
594
|
+
* <code>ResourcePath</code>.</p>
|
|
557
595
|
* </li>
|
|
558
596
|
* </ul>
|
|
559
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route
|
|
560
|
-
* an Endpoint Is Healthy</a> in the
|
|
597
|
+
* <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
|
|
598
|
+
* Determines Whether an Endpoint Is Healthy</a> in the
|
|
599
|
+
* <i>Route 53 Developer Guide</i>.</p>
|
|
561
600
|
*/
|
|
562
601
|
Type: HealthCheckType | string | undefined;
|
|
563
602
|
/**
|
|
564
|
-
* <p>The path that you want Route
|
|
565
|
-
* endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint
|
|
566
|
-
*
|
|
567
|
-
* specify a value for <code>ResourcePath</code>,
|
|
568
|
-
*
|
|
569
|
-
*
|
|
603
|
+
* <p>The path that you want Route 53 to request when performing health checks. The path can be any
|
|
604
|
+
* value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint
|
|
605
|
+
* is healthy. An example file is <code>/docs/route53-health-check.html</code>. Route 53 automatically
|
|
606
|
+
* adds the DNS name for the service. If you don't specify a value for <code>ResourcePath</code>,
|
|
607
|
+
* the default value is <code>/</code>.</p>
|
|
608
|
+
* <p>If you specify <code>TCP</code> for <code>Type</code>, you must <i>not</i>
|
|
609
|
+
* specify a value for <code>ResourcePath</code>.</p>
|
|
570
610
|
*/
|
|
571
611
|
ResourcePath?: string;
|
|
572
612
|
/**
|
|
573
|
-
* <p>The number of consecutive health checks that an endpoint must pass or fail for Route
|
|
574
|
-
* status of the endpoint from unhealthy to healthy or the other way around. For
|
|
575
|
-
*
|
|
613
|
+
* <p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to
|
|
614
|
+
* change the current status of the endpoint from unhealthy to healthy or the other way around. For
|
|
615
|
+
* more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html">How Route 53
|
|
616
|
+
* Determines Whether an Endpoint Is Healthy</a> in the
|
|
617
|
+
* <i>Route 53 Developer Guide</i>.</p>
|
|
576
618
|
*/
|
|
577
619
|
FailureThreshold?: number;
|
|
578
620
|
}
|
|
579
621
|
/**
|
|
580
|
-
* <p>A complex type that contains information about an optional custom health check. A custom
|
|
581
|
-
* requires that you use a third-party health checker to evaluate the health of
|
|
582
|
-
* following circumstances:</p>
|
|
622
|
+
* <p>A complex type that contains information about an optional custom health check. A custom
|
|
623
|
+
* health check, which requires that you use a third-party health checker to evaluate the health of
|
|
624
|
+
* your resources, is useful in the following circumstances:</p>
|
|
583
625
|
* <ul>
|
|
584
626
|
* <li>
|
|
585
|
-
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
586
|
-
* available over the internet. For example, you can use a custom health check when
|
|
587
|
-
* (To check the health of resources in a VPC, the health
|
|
627
|
+
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
628
|
+
* resource isn't available over the internet. For example, you can use a custom health check when
|
|
629
|
+
* the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health
|
|
630
|
+
* checker must also be in the VPC.)</p>
|
|
588
631
|
* </li>
|
|
589
632
|
* <li>
|
|
590
|
-
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
633
|
+
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
634
|
+
* located.</p>
|
|
591
635
|
* </li>
|
|
592
636
|
* </ul>
|
|
593
637
|
* <important>
|
|
594
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
595
|
-
* <code>HealthCheckConfig</code> but not both.</p>
|
|
638
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
639
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
596
640
|
* </important>
|
|
597
|
-
* <p>To change the status of a custom health check, submit an
|
|
598
|
-
*
|
|
641
|
+
* <p>To change the status of a custom health check, submit an
|
|
642
|
+
* <code>UpdateInstanceCustomHealthStatus</code> request. Cloud Map doesn't monitor the status of the
|
|
643
|
+
* resource, it just keeps a record of the status specified in the most recent
|
|
599
644
|
* <code>UpdateInstanceCustomHealthStatus</code> request.</p>
|
|
600
645
|
* <p>Here's how custom health checks work:</p>
|
|
601
646
|
* <ol>
|
|
@@ -606,13 +651,15 @@ export interface HealthCheckConfig {
|
|
|
606
651
|
* <p>You register an instance.</p>
|
|
607
652
|
* </li>
|
|
608
653
|
* <li>
|
|
609
|
-
* <p>You configure a third-party health checker to monitor the resource that's associated with
|
|
654
|
+
* <p>You configure a third-party health checker to monitor the resource that's associated with
|
|
655
|
+
* the new instance. </p>
|
|
610
656
|
* <note>
|
|
611
657
|
* <p>Cloud Map doesn't check the health of the resource directly. </p>
|
|
612
658
|
* </note>
|
|
613
659
|
* </li>
|
|
614
660
|
* <li>
|
|
615
|
-
* <p>The third-party health-checker determines that the resource is unhealthy and notifies your
|
|
661
|
+
* <p>The third-party health-checker determines that the resource is unhealthy and notifies your
|
|
662
|
+
* application.</p>
|
|
616
663
|
* </li>
|
|
617
664
|
* <li>
|
|
618
665
|
* <p>Your application submits an <code>UpdateInstanceCustomHealthStatus</code> request.</p>
|
|
@@ -621,8 +668,9 @@ export interface HealthCheckConfig {
|
|
|
621
668
|
* <p>Cloud Map waits for 30 seconds.</p>
|
|
622
669
|
* </li>
|
|
623
670
|
* <li>
|
|
624
|
-
* <p>If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during
|
|
625
|
-
* status back to healthy, Cloud Map stops routing traffic to the
|
|
671
|
+
* <p>If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during
|
|
672
|
+
* that time to change the status back to healthy, Cloud Map stops routing traffic to the
|
|
673
|
+
* resource.</p>
|
|
626
674
|
* </li>
|
|
627
675
|
* </ol>
|
|
628
676
|
*/
|
|
@@ -631,16 +679,16 @@ export interface HealthCheckCustomConfig {
|
|
|
631
679
|
* @deprecated
|
|
632
680
|
*
|
|
633
681
|
* <important>
|
|
634
|
-
* <p>This parameter is no longer supported and is always set to 1. Cloud Map waits for
|
|
635
|
-
* receiving an <code>UpdateInstanceCustomHealthStatus</code>
|
|
636
|
-
* instance.</p>
|
|
682
|
+
* <p>This parameter is no longer supported and is always set to 1. Cloud Map waits for
|
|
683
|
+
* approximately 30 seconds after receiving an <code>UpdateInstanceCustomHealthStatus</code>
|
|
684
|
+
* request before changing the status of the service instance.</p>
|
|
637
685
|
* </important>
|
|
638
686
|
* <p>The number of 30-second intervals that you want Cloud Map to wait after receiving an
|
|
639
|
-
* <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a
|
|
640
|
-
* instance.</p>
|
|
641
|
-
* <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with
|
|
642
|
-
* 30 seconds has passed doesn't accelerate the change. Cloud Map still waits
|
|
643
|
-
*
|
|
687
|
+
* <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a
|
|
688
|
+
* service instance.</p>
|
|
689
|
+
* <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with
|
|
690
|
+
* the same value before 30 seconds has passed doesn't accelerate the change. Cloud Map still waits
|
|
691
|
+
* <code>30</code> seconds after the first request to make the change.</p>
|
|
644
692
|
*/
|
|
645
693
|
FailureThreshold?: number;
|
|
646
694
|
}
|
|
@@ -650,6 +698,11 @@ export declare enum ServiceTypeOption {
|
|
|
650
698
|
export interface CreateServiceRequest {
|
|
651
699
|
/**
|
|
652
700
|
* <p>The name that you want to assign to the service.</p>
|
|
701
|
+
*
|
|
702
|
+
* <note>
|
|
703
|
+
* <p>Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.</p>
|
|
704
|
+
* </note>
|
|
705
|
+
*
|
|
653
706
|
* <p>If you want Cloud Map to create an <code>SRV</code> record when you register an instance and you're using a
|
|
654
707
|
* system that requires a specific <code>SRV</code> format, such as <a href="http://www.haproxy.org/">HAProxy</a>, specify the following for <code>Name</code>:</p>
|
|
655
708
|
* <ul>
|
|
@@ -660,27 +713,28 @@ export interface CreateServiceRequest {
|
|
|
660
713
|
* <p>End the name with <i>._protocol</i>, such as <code>._tcp</code>.</p>
|
|
661
714
|
* </li>
|
|
662
715
|
* </ul>
|
|
663
|
-
* <p>When you register an instance, Cloud Map creates an <code>SRV</code> record and assigns a
|
|
664
|
-
* concatenating the service name and the namespace name (for example,</p>
|
|
716
|
+
* <p>When you register an instance, Cloud Map creates an <code>SRV</code> record and assigns a
|
|
717
|
+
* name to the record by concatenating the service name and the namespace name (for example,</p>
|
|
665
718
|
* <p>
|
|
666
719
|
* <code>_exampleservice._tcp.example.com</code>).</p>
|
|
667
720
|
* <note>
|
|
668
|
-
* <p>For services that are accessible by DNS queries, you can't create multiple services with
|
|
669
|
-
* by case (such as EXAMPLE and example). Otherwise, these services have the
|
|
670
|
-
* However, if you use a namespace that's only accessible
|
|
671
|
-
* that differ only by case.</p>
|
|
721
|
+
* <p>For services that are accessible by DNS queries, you can't create multiple services with
|
|
722
|
+
* names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the
|
|
723
|
+
* same DNS name and can't be distinguished. However, if you use a namespace that's only accessible
|
|
724
|
+
* by API calls, then you can create services that with names that differ only by case.</p>
|
|
672
725
|
* </note>
|
|
673
726
|
*/
|
|
674
727
|
Name: string | undefined;
|
|
675
728
|
/**
|
|
676
|
-
* <p>The ID of the namespace that you want to use to create the service. The namespace ID must be
|
|
677
|
-
* can be specified either here or in the <code>DnsConfig</code> object.</p>
|
|
729
|
+
* <p>The ID of the namespace that you want to use to create the service. The namespace ID must be
|
|
730
|
+
* specified, but it can be specified either here or in the <code>DnsConfig</code> object.</p>
|
|
678
731
|
*/
|
|
679
732
|
NamespaceId?: string;
|
|
680
733
|
/**
|
|
681
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
682
|
-
*
|
|
683
|
-
* example, a
|
|
734
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
735
|
+
* <code>CreateService</code> requests to be retried without the risk of running the operation
|
|
736
|
+
* twice. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
737
|
+
* date/timestamp).</p>
|
|
684
738
|
*/
|
|
685
739
|
CreatorRequestId?: string;
|
|
686
740
|
/**
|
|
@@ -688,18 +742,19 @@ export interface CreateServiceRequest {
|
|
|
688
742
|
*/
|
|
689
743
|
Description?: string;
|
|
690
744
|
/**
|
|
691
|
-
* <p>A complex type that contains information about the Amazon Route
|
|
692
|
-
* register an instance. </p>
|
|
745
|
+
* <p>A complex type that contains information about the Amazon Route 53 records that you want
|
|
746
|
+
* Cloud Map to create when you register an instance. </p>
|
|
693
747
|
*/
|
|
694
748
|
DnsConfig?: DnsConfig;
|
|
695
749
|
/**
|
|
696
750
|
* <p>
|
|
697
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
698
|
-
* Route
|
|
699
|
-
* Route
|
|
751
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
752
|
+
* settings for an optional Route 53 health check. If you specify settings for a health check,
|
|
753
|
+
* Cloud Map associates the health check with all the Route 53 DNS records that you specify in
|
|
754
|
+
* <code>DnsConfig</code>.</p>
|
|
700
755
|
* <important>
|
|
701
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
702
|
-
* <code>HealthCheckConfig</code> but not both.</p>
|
|
756
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
757
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
703
758
|
* </important>
|
|
704
759
|
* <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/cloud-map/pricing/">Cloud Map Pricing</a>.</p>
|
|
705
760
|
*/
|
|
@@ -707,23 +762,23 @@ export interface CreateServiceRequest {
|
|
|
707
762
|
/**
|
|
708
763
|
* <p>A complex type that contains information about an optional custom health check.</p>
|
|
709
764
|
* <important>
|
|
710
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
711
|
-
* <code>HealthCheckConfig</code> but not both.</p>
|
|
765
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
766
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
712
767
|
* </important>
|
|
713
|
-
* <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration from
|
|
714
|
-
* service.</p>
|
|
768
|
+
* <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code> configuration from
|
|
769
|
+
* an existing service.</p>
|
|
715
770
|
*/
|
|
716
771
|
HealthCheckCustomConfig?: HealthCheckCustomConfig;
|
|
717
772
|
/**
|
|
718
|
-
* <p>The tags to add to the service. Each tag consists of a key and an optional value that you
|
|
719
|
-
* Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
773
|
+
* <p>The tags to add to the service. Each tag consists of a key and an optional value that you
|
|
774
|
+
* define. Tags keys can be up to 128 characters in length, and tag values can be up to 256
|
|
720
775
|
* characters in length.</p>
|
|
721
776
|
*/
|
|
722
777
|
Tags?: Tag[];
|
|
723
778
|
/**
|
|
724
|
-
* <p>If present, specifies that the service instances are only discoverable using the
|
|
725
|
-
*
|
|
726
|
-
* <code>HTTP</code>.</p>
|
|
779
|
+
* <p>If present, specifies that the service instances are only discoverable using the
|
|
780
|
+
* <code>DiscoverInstances</code> API operation. No DNS records is registered for the service
|
|
781
|
+
* instances. The only valid value is <code>HTTP</code>.</p>
|
|
727
782
|
*/
|
|
728
783
|
Type?: ServiceTypeOption | string;
|
|
729
784
|
}
|
|
@@ -757,14 +812,18 @@ export interface Service {
|
|
|
757
812
|
*/
|
|
758
813
|
Description?: string;
|
|
759
814
|
/**
|
|
760
|
-
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
761
|
-
* associated with the service but that are deleted aren't included in the count. The
|
|
762
|
-
* registrations and deregistrations.</p>
|
|
815
|
+
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
816
|
+
* previously associated with the service but that are deleted aren't included in the count. The
|
|
817
|
+
* count might not reflect pending registrations and deregistrations.</p>
|
|
763
818
|
*/
|
|
764
819
|
InstanceCount?: number;
|
|
765
820
|
/**
|
|
766
|
-
* <p>A complex type that contains information about the Route
|
|
767
|
-
* register an instance.</p>
|
|
821
|
+
* <p>A complex type that contains information about the Route 53 DNS records that you want
|
|
822
|
+
* Cloud Map to create when you register an instance.</p>
|
|
823
|
+
* <important>
|
|
824
|
+
* <p>The record types of a service can only be changed by deleting the service and recreating it
|
|
825
|
+
* with a new <code>Dnsconfig</code>.</p>
|
|
826
|
+
* </important>
|
|
768
827
|
*/
|
|
769
828
|
DnsConfig?: DnsConfig;
|
|
770
829
|
/**
|
|
@@ -772,12 +831,13 @@ export interface Service {
|
|
|
772
831
|
* <dl>
|
|
773
832
|
* <dt>DNS_HTTP</dt>
|
|
774
833
|
* <dd>
|
|
775
|
-
* <p>The service instances can be discovered using either DNS queries or the
|
|
776
|
-
*
|
|
834
|
+
* <p>The service instances can be discovered using either DNS queries or the
|
|
835
|
+
* <code>DiscoverInstances</code> API operation.</p>
|
|
777
836
|
* </dd>
|
|
778
837
|
* <dt>HTTP</dt>
|
|
779
838
|
* <dd>
|
|
780
|
-
* <p>The service instances can only be discovered using the <code>DiscoverInstances</code> API
|
|
839
|
+
* <p>The service instances can only be discovered using the <code>DiscoverInstances</code> API
|
|
840
|
+
* operation.</p>
|
|
781
841
|
* </dd>
|
|
782
842
|
* <dt>DNS</dt>
|
|
783
843
|
* <dd>
|
|
@@ -788,30 +848,30 @@ export interface Service {
|
|
|
788
848
|
Type?: ServiceType | string;
|
|
789
849
|
/**
|
|
790
850
|
* <p>
|
|
791
|
-
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
792
|
-
* health check. If you specify settings for a health check, Cloud Map
|
|
793
|
-
* that you specify in <code>DnsConfig</code>.</p>
|
|
794
|
-
* <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route
|
|
851
|
+
* <i>Public DNS and HTTP namespaces only.</i> A complex type that contains
|
|
852
|
+
* settings for an optional health check. If you specify settings for a health check, Cloud Map
|
|
853
|
+
* associates the health check with the records that you specify in <code>DnsConfig</code>.</p>
|
|
854
|
+
* <p>For information about the charges for health checks, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p>
|
|
795
855
|
*/
|
|
796
856
|
HealthCheckConfig?: HealthCheckConfig;
|
|
797
857
|
/**
|
|
798
858
|
* <p>A complex type that contains information about an optional custom health check.</p>
|
|
799
859
|
* <important>
|
|
800
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
801
|
-
* <code>HealthCheckConfig</code> but not both.</p>
|
|
860
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
861
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
802
862
|
* </important>
|
|
803
863
|
*/
|
|
804
864
|
HealthCheckCustomConfig?: HealthCheckCustomConfig;
|
|
805
865
|
/**
|
|
806
|
-
* <p>The date and time that the service was created, in Unix format and Coordinated Universal
|
|
807
|
-
* of <code>CreateDate</code> is accurate to milliseconds. For example, the
|
|
808
|
-
* Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
866
|
+
* <p>The date and time that the service was created, in Unix format and Coordinated Universal
|
|
867
|
+
* Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the
|
|
868
|
+
* value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
809
869
|
*/
|
|
810
870
|
CreateDate?: Date;
|
|
811
871
|
/**
|
|
812
|
-
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
813
|
-
* running the operation twice. <code>CreatorRequestId</code> can be any unique
|
|
814
|
-
* date/timestamp).</p>
|
|
872
|
+
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
873
|
+
* without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique
|
|
874
|
+
* string (for example, a date/timestamp).</p>
|
|
815
875
|
*/
|
|
816
876
|
CreatorRequestId?: string;
|
|
817
877
|
}
|
|
@@ -854,8 +914,8 @@ export declare class ServiceAlreadyExists extends __BaseException {
|
|
|
854
914
|
constructor(opts: __ExceptionOptionType<ServiceAlreadyExists, __BaseException>);
|
|
855
915
|
}
|
|
856
916
|
/**
|
|
857
|
-
* <p>The health check for the instance that's specified by <code>ServiceId</code> and
|
|
858
|
-
*
|
|
917
|
+
* <p>The health check for the instance that's specified by <code>ServiceId</code> and
|
|
918
|
+
* <code>InstanceId</code> isn't a custom health check. </p>
|
|
859
919
|
*/
|
|
860
920
|
export declare class CustomHealthNotFound extends __BaseException {
|
|
861
921
|
readonly name: "CustomHealthNotFound";
|
|
@@ -884,8 +944,8 @@ export interface DeleteNamespaceResponse {
|
|
|
884
944
|
OperationId?: string;
|
|
885
945
|
}
|
|
886
946
|
/**
|
|
887
|
-
* <p>The specified resource can't be deleted because it contains other resources. For example,
|
|
888
|
-
* service that contains any instances.</p>
|
|
947
|
+
* <p>The specified resource can't be deleted because it contains other resources. For example,
|
|
948
|
+
* you can't delete a service that contains any instances.</p>
|
|
889
949
|
*/
|
|
890
950
|
export declare class ResourceInUse extends __BaseException {
|
|
891
951
|
readonly name: "ResourceInUse";
|
|
@@ -934,8 +994,8 @@ export interface DeregisterInstanceResponse {
|
|
|
934
994
|
OperationId?: string;
|
|
935
995
|
}
|
|
936
996
|
/**
|
|
937
|
-
* <p>No instance exists with the specified ID, or the instance was recently registered, and
|
|
938
|
-
* instance hasn't propagated yet.</p>
|
|
997
|
+
* <p>No instance exists with the specified ID, or the instance was recently registered, and
|
|
998
|
+
* information about the instance hasn't propagated yet.</p>
|
|
939
999
|
*/
|
|
940
1000
|
export declare class InstanceNotFound extends __BaseException {
|
|
941
1001
|
readonly name: "InstanceNotFound";
|
|
@@ -954,8 +1014,9 @@ export declare enum HealthStatusFilter {
|
|
|
954
1014
|
}
|
|
955
1015
|
export interface DiscoverInstancesRequest {
|
|
956
1016
|
/**
|
|
957
|
-
* <p>The <code>HttpName</code> name of the namespace. It's found in the
|
|
958
|
-
* <code>
|
|
1017
|
+
* <p>The <code>HttpName</code> name of the namespace. It's found in the
|
|
1018
|
+
* <code>HttpProperties</code> member of the <code>Properties</code> member of the
|
|
1019
|
+
* namespace.</p>
|
|
959
1020
|
*/
|
|
960
1021
|
NamespaceName: string | undefined;
|
|
961
1022
|
/**
|
|
@@ -964,25 +1025,27 @@ export interface DiscoverInstancesRequest {
|
|
|
964
1025
|
ServiceName: string | undefined;
|
|
965
1026
|
/**
|
|
966
1027
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
967
|
-
* <code>DiscoverInstances</code> request. If you don't specify a value for
|
|
968
|
-
* to 100 instances.</p>
|
|
1028
|
+
* <code>DiscoverInstances</code> request. If you don't specify a value for
|
|
1029
|
+
* <code>MaxResults</code>, Cloud Map returns up to 100 instances.</p>
|
|
969
1030
|
*/
|
|
970
1031
|
MaxResults?: number;
|
|
971
1032
|
/**
|
|
972
|
-
* <p>Filters to scope the results based on custom attributes for the instance (for example,
|
|
973
|
-
* az=1a}</code>). Only instances that match all the specified key-value pairs
|
|
1033
|
+
* <p>Filters to scope the results based on custom attributes for the instance (for example,
|
|
1034
|
+
* <code>{version=v1, az=1a}</code>). Only instances that match all the specified key-value pairs
|
|
1035
|
+
* are returned.</p>
|
|
974
1036
|
*/
|
|
975
1037
|
QueryParameters?: Record<string, string>;
|
|
976
1038
|
/**
|
|
977
|
-
* <p>Opportunistic filters to scope the results based on custom attributes. If there are
|
|
978
|
-
* the filters specified in both the <code>QueryParameters</code>
|
|
979
|
-
*
|
|
1039
|
+
* <p>Opportunistic filters to scope the results based on custom attributes. If there are
|
|
1040
|
+
* instances that match both the filters specified in both the <code>QueryParameters</code>
|
|
1041
|
+
* parameter and this parameter, all of these instances are returned. Otherwise, the filters are
|
|
1042
|
+
* ignored, and only instances that match the filters that are specified in the
|
|
980
1043
|
* <code>QueryParameters</code> parameter are returned.</p>
|
|
981
1044
|
*/
|
|
982
1045
|
OptionalParameters?: Record<string, string>;
|
|
983
1046
|
/**
|
|
984
|
-
* <p>The health status of the instances that you want to discover. This parameter is ignored for
|
|
985
|
-
* have a health check configured, and
|
|
1047
|
+
* <p>The health status of the instances that you want to discover. This parameter is ignored for
|
|
1048
|
+
* services that don't have a health check configured, and
|
|
986
1049
|
* all
|
|
987
1050
|
* instances are returned.</p>
|
|
988
1051
|
* <dl>
|
|
@@ -1000,8 +1063,8 @@ export interface DiscoverInstancesRequest {
|
|
|
1000
1063
|
* </dd>
|
|
1001
1064
|
* <dt>HEALTHY_OR_ELSE_ALL</dt>
|
|
1002
1065
|
* <dd>
|
|
1003
|
-
* <p>Returns healthy instances, unless none are reporting a healthy state. In that case,
|
|
1004
|
-
* This is also called failing open.</p>
|
|
1066
|
+
* <p>Returns healthy instances, unless none are reporting a healthy state. In that case,
|
|
1067
|
+
* return all instances. This is also called failing open.</p>
|
|
1005
1068
|
* </dd>
|
|
1006
1069
|
* </dl>
|
|
1007
1070
|
*/
|
|
@@ -1013,8 +1076,9 @@ export declare enum HealthStatus {
|
|
|
1013
1076
|
UNKNOWN = "UNKNOWN"
|
|
1014
1077
|
}
|
|
1015
1078
|
/**
|
|
1016
|
-
* <p>In a response to a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a> request,
|
|
1017
|
-
*
|
|
1079
|
+
* <p>In a response to a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html">DiscoverInstances</a> request,
|
|
1080
|
+
* <code>HttpInstanceSummary</code> contains information about one instance that matches the values
|
|
1081
|
+
* that you specified in the request.</p>
|
|
1018
1082
|
*/
|
|
1019
1083
|
export interface HttpInstanceSummary {
|
|
1020
1084
|
/**
|
|
@@ -1027,8 +1091,9 @@ export interface HttpInstanceSummary {
|
|
|
1027
1091
|
* <code></code>
|
|
1028
1092
|
* <code></code>
|
|
1029
1093
|
* </p>
|
|
1030
|
-
* <p>The <code>HttpName</code> name of the namespace. It's found in the
|
|
1031
|
-
* <code>
|
|
1094
|
+
* <p>The <code>HttpName</code> name of the namespace. It's found in the
|
|
1095
|
+
* <code>HttpProperties</code> member of the <code>Properties</code> member of the
|
|
1096
|
+
* namespace.</p>
|
|
1032
1097
|
*/
|
|
1033
1098
|
NamespaceName?: string;
|
|
1034
1099
|
/**
|
|
@@ -1036,24 +1101,27 @@ export interface HttpInstanceSummary {
|
|
|
1036
1101
|
*/
|
|
1037
1102
|
ServiceName?: string;
|
|
1038
1103
|
/**
|
|
1039
|
-
* <p>If you configured health checking in the service, the current health status of the service
|
|
1104
|
+
* <p>If you configured health checking in the service, the current health status of the service
|
|
1105
|
+
* instance.</p>
|
|
1040
1106
|
*/
|
|
1041
1107
|
HealthStatus?: HealthStatus | string;
|
|
1042
1108
|
/**
|
|
1043
|
-
* <p>If you included any attributes when you registered the instance, the values of those
|
|
1109
|
+
* <p>If you included any attributes when you registered the instance, the values of those
|
|
1110
|
+
* attributes.</p>
|
|
1044
1111
|
*/
|
|
1045
1112
|
Attributes?: Record<string, string>;
|
|
1046
1113
|
}
|
|
1047
1114
|
export interface DiscoverInstancesResponse {
|
|
1048
1115
|
/**
|
|
1049
|
-
* <p>A complex type that contains one <code>HttpInstanceSummary</code> for each registered
|
|
1116
|
+
* <p>A complex type that contains one <code>HttpInstanceSummary</code> for each registered
|
|
1117
|
+
* instance.</p>
|
|
1050
1118
|
*/
|
|
1051
1119
|
Instances?: HttpInstanceSummary[];
|
|
1052
1120
|
}
|
|
1053
1121
|
/**
|
|
1054
|
-
* <p>The operation can't be completed because you've reached the quota for the number of
|
|
1055
|
-
* information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html">Cloud Map API request throttling
|
|
1056
|
-
*
|
|
1122
|
+
* <p>The operation can't be completed because you've reached the quota for the number of
|
|
1123
|
+
* 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
|
|
1124
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
1057
1125
|
*/
|
|
1058
1126
|
export declare class RequestLimitExceeded extends __BaseException {
|
|
1059
1127
|
readonly name: "RequestLimitExceeded";
|
|
@@ -1065,23 +1133,23 @@ export declare class RequestLimitExceeded extends __BaseException {
|
|
|
1065
1133
|
constructor(opts: __ExceptionOptionType<RequestLimitExceeded, __BaseException>);
|
|
1066
1134
|
}
|
|
1067
1135
|
/**
|
|
1068
|
-
* <p>A complex type that contains information about changes to the Route
|
|
1069
|
-
* register an instance.</p>
|
|
1136
|
+
* <p>A complex type that contains information about changes to the Route 53 DNS records that
|
|
1137
|
+
* Cloud Map creates when you register an instance.</p>
|
|
1070
1138
|
*/
|
|
1071
1139
|
export interface DnsConfigChange {
|
|
1072
1140
|
/**
|
|
1073
|
-
* <p>An array that contains one <code>DnsRecord</code> object for each Route
|
|
1074
|
-
* create when you register an instance.</p>
|
|
1141
|
+
* <p>An array that contains one <code>DnsRecord</code> object for each Route 53 record that you want
|
|
1142
|
+
* Cloud Map to create when you register an instance.</p>
|
|
1075
1143
|
*/
|
|
1076
1144
|
DnsRecords: DnsRecord[] | undefined;
|
|
1077
1145
|
}
|
|
1078
1146
|
/**
|
|
1079
|
-
* <p>A complex type that contains the ID for the Route
|
|
1080
|
-
* namespace.</p>
|
|
1147
|
+
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
|
|
1148
|
+
* you create a namespace.</p>
|
|
1081
1149
|
*/
|
|
1082
1150
|
export interface DnsProperties {
|
|
1083
1151
|
/**
|
|
1084
|
-
* <p>The ID for the Route
|
|
1152
|
+
* <p>The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.</p>
|
|
1085
1153
|
*/
|
|
1086
1154
|
HostedZoneId?: string;
|
|
1087
1155
|
/**
|
|
@@ -1090,6 +1158,7 @@ export interface DnsProperties {
|
|
|
1090
1158
|
SOA?: SOA;
|
|
1091
1159
|
}
|
|
1092
1160
|
export declare enum FilterCondition {
|
|
1161
|
+
BEGINS_WITH = "BEGINS_WITH",
|
|
1093
1162
|
BETWEEN = "BETWEEN",
|
|
1094
1163
|
EQ = "EQ",
|
|
1095
1164
|
IN = "IN"
|
|
@@ -1105,48 +1174,50 @@ export interface GetInstanceRequest {
|
|
|
1105
1174
|
InstanceId: string | undefined;
|
|
1106
1175
|
}
|
|
1107
1176
|
/**
|
|
1108
|
-
* <p>A complex type that contains information about an instance that Cloud Map creates when you
|
|
1109
|
-
*
|
|
1177
|
+
* <p>A complex type that contains information about an instance that Cloud Map creates when you
|
|
1178
|
+
* submit a <code>RegisterInstance</code> request.</p>
|
|
1110
1179
|
*/
|
|
1111
1180
|
export interface Instance {
|
|
1112
1181
|
/**
|
|
1113
1182
|
* <p>An identifier that you want to associate with the instance. Note the following:</p>
|
|
1114
1183
|
* <ul>
|
|
1115
1184
|
* <li>
|
|
1116
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
1117
|
-
*
|
|
1118
|
-
* record. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type">DnsRecord >
|
|
1185
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
1186
|
+
* <code>SRV</code> record, the value of <code>InstanceId</code> is automatically included as
|
|
1187
|
+
* 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 >
|
|
1188
|
+
* Type</a>.</p>
|
|
1119
1189
|
* </li>
|
|
1120
1190
|
* <li>
|
|
1121
1191
|
* <p>You can use this value to update an existing instance.</p>
|
|
1122
1192
|
* </li>
|
|
1123
1193
|
* <li>
|
|
1124
|
-
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
1125
|
-
* the same service. </p>
|
|
1194
|
+
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
1195
|
+
* you register by using the same service. </p>
|
|
1126
1196
|
* </li>
|
|
1127
1197
|
* <li>
|
|
1128
|
-
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
1129
|
-
* DNS records. If there's also an existing health check, Cloud Map deletes
|
|
1130
|
-
* one. </p>
|
|
1198
|
+
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
1199
|
+
* updates the existing DNS records. If there's also an existing health check, Cloud Map deletes
|
|
1200
|
+
* the old health check and creates a new one. </p>
|
|
1131
1201
|
* <note>
|
|
1132
|
-
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
1133
|
-
*
|
|
1202
|
+
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
1203
|
+
* submit a <code>ListHealthChecks</code> request, for example.</p>
|
|
1134
1204
|
* </note>
|
|
1135
1205
|
* </li>
|
|
1136
1206
|
* </ul>
|
|
1137
1207
|
*/
|
|
1138
1208
|
Id: string | undefined;
|
|
1139
1209
|
/**
|
|
1140
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
1141
|
-
*
|
|
1142
|
-
*
|
|
1143
|
-
*
|
|
1144
|
-
*
|
|
1210
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
1211
|
+
* <code>RegisterInstance</code> requests to be retried without the risk of executing the operation
|
|
1212
|
+
* twice. You must use a unique <code>CreatorRequestId</code> string every time you submit a
|
|
1213
|
+
* <code>RegisterInstance</code> request if you're registering additional instances for the same
|
|
1214
|
+
* namespace and service. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
1215
|
+
* date/time stamp).</p>
|
|
1145
1216
|
*/
|
|
1146
1217
|
CreatorRequestId?: string;
|
|
1147
1218
|
/**
|
|
1148
1219
|
* <p>A string map that contains the following information for the service that you specify in
|
|
1149
|
-
*
|
|
1220
|
+
* <code>ServiceId</code>:</p>
|
|
1150
1221
|
* <ul>
|
|
1151
1222
|
* <li>
|
|
1152
1223
|
* <p>The attributes that apply to the records that are defined in the service. </p>
|
|
@@ -1155,33 +1226,41 @@ export interface Instance {
|
|
|
1155
1226
|
* <p>For each attribute, the applicable value.</p>
|
|
1156
1227
|
* </li>
|
|
1157
1228
|
* </ul>
|
|
1229
|
+
*
|
|
1230
|
+
* <note>
|
|
1231
|
+
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by public DNS
|
|
1232
|
+
* queries.</p>
|
|
1233
|
+
* </note>
|
|
1234
|
+
*
|
|
1158
1235
|
* <p>Supported attribute keys include the following:</p>
|
|
1159
1236
|
* <dl>
|
|
1160
1237
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
1161
1238
|
* <dd>
|
|
1162
|
-
* <p>If you want Cloud Map to create a Route
|
|
1163
|
-
* the DNS name that's associated with the load balancer. For information
|
|
1239
|
+
* <p>If you want Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing
|
|
1240
|
+
* load balancer, specify the DNS name that's associated with the load balancer. For information
|
|
1241
|
+
* 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>
|
|
1164
1242
|
* <p>Note the following:</p>
|
|
1165
1243
|
* <ul>
|
|
1166
1244
|
* <li>
|
|
1167
|
-
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
1168
|
-
*
|
|
1245
|
+
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
1246
|
+
* include settings for an <code>A</code> record, an <code>AAAA</code> record, or both.</p>
|
|
1169
1247
|
* </li>
|
|
1170
1248
|
* <li>
|
|
1171
|
-
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
1172
|
-
* <code>WEIGHTED</code>.</p>
|
|
1249
|
+
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
1250
|
+
* <code>RoutingPolicy</code> must be <code>WEIGHTED</code>.</p>
|
|
1173
1251
|
* </li>
|
|
1174
1252
|
* <li>
|
|
1175
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
1176
|
-
*
|
|
1253
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
1254
|
+
* <code>HealthCheckConfig</code> settings, Cloud Map creates the health check, but it won't
|
|
1255
|
+
* associate the health check with the alias record.</p>
|
|
1177
1256
|
* </li>
|
|
1178
1257
|
* <li>
|
|
1179
|
-
* <p>Auto naming currently doesn't support creating alias records that route traffic to
|
|
1180
|
-
* than ELB load balancers.</p>
|
|
1258
|
+
* <p>Auto naming currently doesn't support creating alias records that route traffic to
|
|
1259
|
+
* Amazon Web Services resources other than ELB load balancers.</p>
|
|
1181
1260
|
* </li>
|
|
1182
1261
|
* <li>
|
|
1183
|
-
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
1184
|
-
*
|
|
1262
|
+
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
1263
|
+
* any of the <code>AWS_INSTANCE</code> attributes.</p>
|
|
1185
1264
|
* </li>
|
|
1186
1265
|
* </ul>
|
|
1187
1266
|
* </dd>
|
|
@@ -1193,42 +1272,46 @@ export interface Instance {
|
|
|
1193
1272
|
* </dd>
|
|
1194
1273
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
1195
1274
|
* <dd>
|
|
1196
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
1197
|
-
*
|
|
1198
|
-
*
|
|
1275
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
1276
|
+
* optionally use <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom
|
|
1277
|
+
* health check, <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
1199
1278
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
1200
1279
|
* </dd>
|
|
1201
1280
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
1202
1281
|
* <dd>
|
|
1203
|
-
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
1204
|
-
* return in response to DNS queries (for example,
|
|
1205
|
-
*
|
|
1206
|
-
*
|
|
1282
|
+
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
1283
|
+
* you want Route 53 to return in response to DNS queries (for example,
|
|
1284
|
+
* <code>example.com</code>).</p>
|
|
1285
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1286
|
+
* settings for an <code>CNAME</code> record.</p>
|
|
1207
1287
|
* </dd>
|
|
1208
1288
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
1209
1289
|
* <dd>
|
|
1210
|
-
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
1211
|
-
* return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
1212
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1213
|
-
*
|
|
1214
|
-
*
|
|
1290
|
+
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
1291
|
+
* want Route 53 to return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
1292
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1293
|
+
* settings for an <code>A</code> record. If the service includes settings for an
|
|
1294
|
+
* <code>SRV</code> record, you must specify a value for <code>AWS_INSTANCE_IPV4</code>,
|
|
1295
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
1215
1296
|
* </dd>
|
|
1216
1297
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
1217
1298
|
* <dd>
|
|
1218
|
-
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
1219
|
-
* return in response to DNS queries (for example,
|
|
1220
|
-
*
|
|
1221
|
-
*
|
|
1222
|
-
*
|
|
1299
|
+
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
1300
|
+
* you want Route 53 to return in response to DNS queries (for example,
|
|
1301
|
+
* <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
1302
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
1303
|
+
* settings for an <code>AAAA</code> record. If the service includes settings for an
|
|
1304
|
+
* <code>SRV</code> record, you must specify a value for <code>AWS_INSTANCE_IPV4</code>,
|
|
1305
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
1223
1306
|
* </dd>
|
|
1224
1307
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
1225
1308
|
* <dd>
|
|
1226
|
-
* <p>If the service includes an <code>SRV</code> record, the value that you want Route
|
|
1227
|
-
* port.</p>
|
|
1228
|
-
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
1229
|
-
* requests to. </p>
|
|
1230
|
-
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
1231
|
-
* you created the service.</p>
|
|
1309
|
+
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to
|
|
1310
|
+
* return for the port.</p>
|
|
1311
|
+
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
1312
|
+
* want Route 53 to send requests to. </p>
|
|
1313
|
+
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
1314
|
+
* Route 53 health check when you created the service.</p>
|
|
1232
1315
|
* </dd>
|
|
1233
1316
|
* </dl>
|
|
1234
1317
|
*/
|
|
@@ -1246,38 +1329,40 @@ export interface GetInstancesHealthStatusRequest {
|
|
|
1246
1329
|
*/
|
|
1247
1330
|
ServiceId: string | undefined;
|
|
1248
1331
|
/**
|
|
1249
|
-
* <p>An array that contains the IDs of all the instances that you want to get the health status
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1332
|
+
* <p>An array that contains the IDs of all the instances that you want to get the health status
|
|
1333
|
+
* for.</p>
|
|
1334
|
+
* <p>If you omit <code>Instances</code>, Cloud Map returns the health status for all the
|
|
1335
|
+
* instances that are associated with the specified service.</p>
|
|
1252
1336
|
* <note>
|
|
1253
|
-
* <p>To get the IDs for the instances that you've registered by using a specified service,
|
|
1337
|
+
* <p>To get the IDs for the instances that you've registered by using a specified service,
|
|
1338
|
+
* submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html">ListInstances</a> request.</p>
|
|
1254
1339
|
* </note>
|
|
1255
1340
|
*/
|
|
1256
1341
|
Instances?: string[];
|
|
1257
1342
|
/**
|
|
1258
1343
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
1259
|
-
* <code>GetInstancesHealthStatus</code> request. If you don't specify a value for
|
|
1260
|
-
*
|
|
1344
|
+
* <code>GetInstancesHealthStatus</code> request. If you don't specify a value for
|
|
1345
|
+
* <code>MaxResults</code>, Cloud Map returns up to 100 instances.</p>
|
|
1261
1346
|
*/
|
|
1262
1347
|
MaxResults?: number;
|
|
1263
1348
|
/**
|
|
1264
1349
|
* <p>For the first <code>GetInstancesHealthStatus</code> request, omit this value.</p>
|
|
1265
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1266
|
-
*
|
|
1267
|
-
*
|
|
1350
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1351
|
+
* another <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify
|
|
1352
|
+
* the value of <code>NextToken</code> from the previous response in the next request.</p>
|
|
1268
1353
|
*/
|
|
1269
1354
|
NextToken?: string;
|
|
1270
1355
|
}
|
|
1271
1356
|
export interface GetInstancesHealthStatusResponse {
|
|
1272
1357
|
/**
|
|
1273
|
-
* <p>A complex type that contains the IDs and the health status of the instances that you
|
|
1274
|
-
*
|
|
1358
|
+
* <p>A complex type that contains the IDs and the health status of the instances that you
|
|
1359
|
+
* specified in the <code>GetInstancesHealthStatus</code> request.</p>
|
|
1275
1360
|
*/
|
|
1276
1361
|
Status?: Record<string, HealthStatus | string>;
|
|
1277
1362
|
/**
|
|
1278
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1279
|
-
*
|
|
1280
|
-
*
|
|
1363
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1364
|
+
* another <code>GetInstancesHealthStatus</code> request to get the next group of results. Specify
|
|
1365
|
+
* the value of <code>NextToken</code> from the previous response in the next request.</p>
|
|
1281
1366
|
*/
|
|
1282
1367
|
NextToken?: string;
|
|
1283
1368
|
}
|
|
@@ -1301,8 +1386,8 @@ export interface HttpProperties {
|
|
|
1301
1386
|
*/
|
|
1302
1387
|
export interface NamespaceProperties {
|
|
1303
1388
|
/**
|
|
1304
|
-
* <p>A complex type that contains the ID for the Route
|
|
1305
|
-
* namespace.</p>
|
|
1389
|
+
* <p>A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when
|
|
1390
|
+
* you create a namespace.</p>
|
|
1306
1391
|
*/
|
|
1307
1392
|
DnsProperties?: DnsProperties;
|
|
1308
1393
|
/**
|
|
@@ -1332,21 +1417,23 @@ export interface Namespace {
|
|
|
1332
1417
|
*/
|
|
1333
1418
|
Name?: string;
|
|
1334
1419
|
/**
|
|
1335
|
-
* <p>The type of the namespace. The methods for discovering instances depends on the value that
|
|
1420
|
+
* <p>The type of the namespace. The methods for discovering instances depends on the value that
|
|
1421
|
+
* you specify:</p>
|
|
1336
1422
|
* <dl>
|
|
1337
1423
|
* <dt>HTTP</dt>
|
|
1338
1424
|
* <dd>
|
|
1339
|
-
* <p>Instances can be discovered only programmatically, using the Cloud Map
|
|
1340
|
-
*
|
|
1425
|
+
* <p>Instances can be discovered only programmatically, using the Cloud Map
|
|
1426
|
+
* <code>DiscoverInstances</code> API.</p>
|
|
1341
1427
|
* </dd>
|
|
1342
1428
|
* <dt>DNS_PUBLIC</dt>
|
|
1343
1429
|
* <dd>
|
|
1344
|
-
* <p>Instances can be discovered using public DNS queries and using the
|
|
1430
|
+
* <p>Instances can be discovered using public DNS queries and using the
|
|
1431
|
+
* <code>DiscoverInstances</code> API.</p>
|
|
1345
1432
|
* </dd>
|
|
1346
1433
|
* <dt>DNS_PRIVATE</dt>
|
|
1347
1434
|
* <dd>
|
|
1348
|
-
* <p>Instances can be discovered using DNS queries in VPCs and using the
|
|
1349
|
-
*
|
|
1435
|
+
* <p>Instances can be discovered using DNS queries in VPCs and using the
|
|
1436
|
+
* <code>DiscoverInstances</code> API.</p>
|
|
1350
1437
|
* </dd>
|
|
1351
1438
|
* </dl>
|
|
1352
1439
|
*/
|
|
@@ -1360,18 +1447,19 @@ export interface Namespace {
|
|
|
1360
1447
|
*/
|
|
1361
1448
|
ServiceCount?: number;
|
|
1362
1449
|
/**
|
|
1363
|
-
* <p>A complex type that contains information that's specific to the type of the
|
|
1450
|
+
* <p>A complex type that contains information that's specific to the type of the
|
|
1451
|
+
* namespace.</p>
|
|
1364
1452
|
*/
|
|
1365
1453
|
Properties?: NamespaceProperties;
|
|
1366
1454
|
/**
|
|
1367
|
-
* <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal
|
|
1368
|
-
* value of <code>CreateDate</code> is accurate to milliseconds. For example, the
|
|
1369
|
-
* represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1455
|
+
* <p>The date that the namespace was created, in Unix date/time format and Coordinated Universal
|
|
1456
|
+
* Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the
|
|
1457
|
+
* value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1370
1458
|
*/
|
|
1371
1459
|
CreateDate?: Date;
|
|
1372
1460
|
/**
|
|
1373
|
-
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
1374
|
-
* running an operation twice. </p>
|
|
1461
|
+
* <p>A unique string that identifies the request and that allows failed requests to be retried
|
|
1462
|
+
* without the risk of running an operation twice. </p>
|
|
1375
1463
|
*/
|
|
1376
1464
|
CreatorRequestId?: string;
|
|
1377
1465
|
}
|
|
@@ -1441,12 +1529,13 @@ export interface Operation {
|
|
|
1441
1529
|
*/
|
|
1442
1530
|
Status?: OperationStatus | string;
|
|
1443
1531
|
/**
|
|
1444
|
-
* <p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation
|
|
1532
|
+
* <p>If the value of <code>Status</code> is <code>FAIL</code>, the reason that the operation
|
|
1533
|
+
* failed.</p>
|
|
1445
1534
|
*/
|
|
1446
1535
|
ErrorMessage?: string;
|
|
1447
1536
|
/**
|
|
1448
|
-
* <p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code>
|
|
1449
|
-
* following:</p>
|
|
1537
|
+
* <p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code>
|
|
1538
|
+
* include the following:</p>
|
|
1450
1539
|
* <ul>
|
|
1451
1540
|
* <li>
|
|
1452
1541
|
* <p>
|
|
@@ -1487,15 +1576,17 @@ export interface Operation {
|
|
|
1487
1576
|
*/
|
|
1488
1577
|
ErrorCode?: string;
|
|
1489
1578
|
/**
|
|
1490
|
-
* <p>The date and time that the request was submitted, in Unix date/time format and Coordinated
|
|
1491
|
-
* The value of <code>CreateDate</code> is accurate to milliseconds. For
|
|
1492
|
-
* represents Friday, January 26, 2018 12:11:30.087
|
|
1579
|
+
* <p>The date and time that the request was submitted, in Unix date/time format and Coordinated
|
|
1580
|
+
* Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For
|
|
1581
|
+
* example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087
|
|
1582
|
+
* AM.</p>
|
|
1493
1583
|
*/
|
|
1494
1584
|
CreateDate?: Date;
|
|
1495
1585
|
/**
|
|
1496
|
-
* <p>The date and time that the value of <code>Status</code> changed to the current value, in
|
|
1497
|
-
* and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code>
|
|
1498
|
-
* the value <code>1516925490.087</code> represents
|
|
1586
|
+
* <p>The date and time that the value of <code>Status</code> changed to the current value, in
|
|
1587
|
+
* Unix date/time format and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code>
|
|
1588
|
+
* is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents
|
|
1589
|
+
* Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1499
1590
|
*/
|
|
1500
1591
|
UpdateDate?: Date;
|
|
1501
1592
|
/**
|
|
@@ -1548,19 +1639,19 @@ export interface GetServiceResponse {
|
|
|
1548
1639
|
Service?: Service;
|
|
1549
1640
|
}
|
|
1550
1641
|
/**
|
|
1551
|
-
* <p>Updated properties
|
|
1552
|
-
* namespace.</p>
|
|
1642
|
+
* <p>Updated properties
|
|
1643
|
+
* for the HTTP namespace.</p>
|
|
1553
1644
|
*/
|
|
1554
1645
|
export interface HttpNamespaceChange {
|
|
1555
1646
|
/**
|
|
1556
|
-
* <p>An updated
|
|
1557
|
-
* namespace.</p>
|
|
1647
|
+
* <p>An updated
|
|
1648
|
+
* description for the HTTP namespace.</p>
|
|
1558
1649
|
*/
|
|
1559
1650
|
Description: string | undefined;
|
|
1560
1651
|
}
|
|
1561
1652
|
/**
|
|
1562
|
-
* <p>A complex type that contains information about the instances that you registered by using a
|
|
1563
|
-
* service.</p>
|
|
1653
|
+
* <p>A complex type that contains information about the instances that you registered by using a
|
|
1654
|
+
* specified service.</p>
|
|
1564
1655
|
*/
|
|
1565
1656
|
export interface InstanceSummary {
|
|
1566
1657
|
/**
|
|
@@ -1581,40 +1672,42 @@ export interface InstanceSummary {
|
|
|
1581
1672
|
* <dl>
|
|
1582
1673
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
1583
1674
|
* <dd>
|
|
1584
|
-
* <p>For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
|
|
1585
|
-
* load balancer. </p>
|
|
1675
|
+
* <p>For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's
|
|
1676
|
+
* associated with the load balancer. </p>
|
|
1586
1677
|
* </dd>
|
|
1587
1678
|
* <dt>AWS_EC2_INSTANCE_ID (HTTP namespaces only)</dt>
|
|
1588
1679
|
* <dd>
|
|
1589
|
-
* <p>The Amazon EC2 instance ID for the instance. When the <code>AWS_EC2_INSTANCE_ID</code>
|
|
1590
|
-
* then the <code>AWS_INSTANCE_IPV4</code> attribute contains the primary
|
|
1680
|
+
* <p>The Amazon EC2 instance ID for the instance. When the <code>AWS_EC2_INSTANCE_ID</code>
|
|
1681
|
+
* attribute is specified, then the <code>AWS_INSTANCE_IPV4</code> attribute contains the primary
|
|
1682
|
+
* private IPv4 address.</p>
|
|
1591
1683
|
* </dd>
|
|
1592
1684
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
1593
1685
|
* <dd>
|
|
1594
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
1595
|
-
*
|
|
1596
|
-
*
|
|
1686
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
1687
|
+
* optionally use <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom
|
|
1688
|
+
* health check, <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
1597
1689
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
1598
1690
|
* </dd>
|
|
1599
1691
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
1600
1692
|
* <dd>
|
|
1601
|
-
* <p>For a <code>CNAME</code> record, the domain name that Route
|
|
1602
|
-
*
|
|
1693
|
+
* <p>For a <code>CNAME</code> record, the domain name that Route 53 returns in response to DNS
|
|
1694
|
+
* queries (for example, <code>example.com</code>).</p>
|
|
1603
1695
|
* </dd>
|
|
1604
1696
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
1605
1697
|
* <dd>
|
|
1606
|
-
* <p>For an <code>A</code> record, the IPv4 address that Route
|
|
1607
|
-
*
|
|
1698
|
+
* <p>For an <code>A</code> record, the IPv4 address that Route 53 returns in response to DNS
|
|
1699
|
+
* queries (for example, <code>192.0.2.44</code>).</p>
|
|
1608
1700
|
* </dd>
|
|
1609
1701
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
1610
1702
|
* <dd>
|
|
1611
|
-
* <p>For an <code>AAAA</code> record, the IPv6 address that Route
|
|
1612
|
-
*
|
|
1703
|
+
* <p>For an <code>AAAA</code> record, the IPv6 address that Route 53 returns in response to DNS
|
|
1704
|
+
* queries (for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
1613
1705
|
* </dd>
|
|
1614
1706
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
1615
1707
|
* <dd>
|
|
1616
|
-
* <p>For an <code>SRV</code> record, the value that Route
|
|
1617
|
-
* includes <code>HealthCheckConfig</code>, the port on the endpoint that Route
|
|
1708
|
+
* <p>For an <code>SRV</code> record, the value that Route 53 returns for the port. In addition,
|
|
1709
|
+
* if the service includes <code>HealthCheckConfig</code>, the port on the endpoint that Route 53
|
|
1710
|
+
* sends requests to.</p>
|
|
1618
1711
|
* </dd>
|
|
1619
1712
|
* </dl>
|
|
1620
1713
|
*/
|
|
@@ -1627,88 +1720,120 @@ export interface ListInstancesRequest {
|
|
|
1627
1720
|
ServiceId: string | undefined;
|
|
1628
1721
|
/**
|
|
1629
1722
|
* <p>For the first <code>ListInstances</code> request, omit this value.</p>
|
|
1630
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1631
|
-
*
|
|
1632
|
-
*
|
|
1723
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1724
|
+
* another <code>ListInstances</code> request to get the next group of results. Specify the value of
|
|
1725
|
+
* <code>NextToken</code> from the previous response in the next request.</p>
|
|
1633
1726
|
*/
|
|
1634
1727
|
NextToken?: string;
|
|
1635
1728
|
/**
|
|
1636
1729
|
* <p>The maximum number of instances that you want Cloud Map to return in the response to a
|
|
1637
|
-
* <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
1638
|
-
* to 100 instances.</p>
|
|
1730
|
+
* <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
1731
|
+
* Cloud Map returns up to 100 instances.</p>
|
|
1639
1732
|
*/
|
|
1640
1733
|
MaxResults?: number;
|
|
1641
1734
|
}
|
|
1642
1735
|
export interface ListInstancesResponse {
|
|
1643
1736
|
/**
|
|
1644
|
-
* <p>Summary information about the instances that are associated with the specified
|
|
1737
|
+
* <p>Summary information about the instances that are associated with the specified
|
|
1738
|
+
* service.</p>
|
|
1645
1739
|
*/
|
|
1646
1740
|
Instances?: InstanceSummary[];
|
|
1647
1741
|
/**
|
|
1648
|
-
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1649
|
-
*
|
|
1650
|
-
*
|
|
1742
|
+
* <p>If more than <code>MaxResults</code> instances match the specified criteria, you can submit
|
|
1743
|
+
* another <code>ListInstances</code> request to get the next group of results. Specify the value of
|
|
1744
|
+
* <code>NextToken</code> from the previous response in the next request.</p>
|
|
1651
1745
|
*/
|
|
1652
1746
|
NextToken?: string;
|
|
1653
1747
|
}
|
|
1654
1748
|
export declare enum NamespaceFilterName {
|
|
1749
|
+
HTTP_NAME = "HTTP_NAME",
|
|
1750
|
+
NAME = "NAME",
|
|
1655
1751
|
TYPE = "TYPE"
|
|
1656
1752
|
}
|
|
1657
1753
|
/**
|
|
1658
|
-
* <p>A complex type that identifies the namespaces that you want to list. You can choose to list
|
|
1659
|
-
* namespaces.</p>
|
|
1754
|
+
* <p>A complex type that identifies the namespaces that you want to list. You can choose to list
|
|
1755
|
+
* public or private namespaces.</p>
|
|
1660
1756
|
*/
|
|
1661
1757
|
export interface NamespaceFilter {
|
|
1662
1758
|
/**
|
|
1663
|
-
* <p>Specify
|
|
1759
|
+
* <p>Specify the namespaces that you want to get using one of the following.</p>
|
|
1760
|
+
* <ul>
|
|
1761
|
+
* <li>
|
|
1762
|
+
* <p>
|
|
1763
|
+
* <code>TYPE</code>: Gets the namespaces of the specified type.</p>
|
|
1764
|
+
* </li>
|
|
1765
|
+
* <li>
|
|
1766
|
+
* <p>
|
|
1767
|
+
* <code>NAME</code>: Gets the namespaces with the specified name.</p>
|
|
1768
|
+
* </li>
|
|
1769
|
+
* <li>
|
|
1770
|
+
* <p>
|
|
1771
|
+
* <code>HTTP_NAME</code>: Gets the namespaces with the specified HTTP name.</p>
|
|
1772
|
+
* </li>
|
|
1773
|
+
* </ul>
|
|
1664
1774
|
*/
|
|
1665
1775
|
Name: NamespaceFilterName | string | undefined;
|
|
1666
1776
|
/**
|
|
1667
|
-
* <p>
|
|
1668
|
-
*
|
|
1669
|
-
* <
|
|
1670
|
-
*
|
|
1777
|
+
* <p>Specify the values that are applicable to the value that you specify for
|
|
1778
|
+
* <code>Name</code>.</p>
|
|
1779
|
+
* <ul>
|
|
1780
|
+
* <li>
|
|
1781
|
+
* <p>
|
|
1782
|
+
* <code>TYPE</code>: Specify <code>HTTP</code>, <code>DNS_PUBLIC</code>, or
|
|
1783
|
+
* <code>DNS_PRIVATE</code>.</p>
|
|
1784
|
+
* </li>
|
|
1785
|
+
* <li>
|
|
1786
|
+
* <p>
|
|
1787
|
+
* <code>NAME</code>: Specify the name of the namespace, which is found in
|
|
1788
|
+
* <code>Namespace.Name</code>.</p>
|
|
1789
|
+
* </li>
|
|
1790
|
+
* <li>
|
|
1791
|
+
* <p>
|
|
1792
|
+
* <code>HTTP_NAME</code>: Specify the HTTP name of the namespace, which is found in
|
|
1793
|
+
* <code>Namespace.Properties.HttpProperties.HttpName</code>.</p>
|
|
1794
|
+
* </li>
|
|
1795
|
+
* </ul>
|
|
1671
1796
|
*/
|
|
1672
1797
|
Values: string[] | undefined;
|
|
1673
1798
|
/**
|
|
1674
|
-
* <p>
|
|
1675
|
-
*
|
|
1676
|
-
* <
|
|
1677
|
-
* <
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
1680
|
-
*
|
|
1681
|
-
*
|
|
1682
|
-
*
|
|
1683
|
-
*
|
|
1684
|
-
*
|
|
1685
|
-
*
|
|
1686
|
-
*
|
|
1687
|
-
*
|
|
1688
|
-
*
|
|
1689
|
-
*
|
|
1690
|
-
*
|
|
1691
|
-
* </dl>
|
|
1799
|
+
* <p>Specify the operator that you want to use to determine whether a namespace matches the
|
|
1800
|
+
* specified value. Valid values for <code>Condition</code> are one of the following.</p>
|
|
1801
|
+
* <ul>
|
|
1802
|
+
* <li>
|
|
1803
|
+
* <p>
|
|
1804
|
+
* <code>EQ</code>: When you specify <code>EQ</code> for <code>Condition</code>, you can
|
|
1805
|
+
* specify only one value. <code>EQ</code> is supported for <code>TYPE</code>, <code>NAME</code>,
|
|
1806
|
+
* and <code>HTTP_NAME</code>. <code>EQ</code> is the default condition and can be
|
|
1807
|
+
* omitted.</p>
|
|
1808
|
+
* </li>
|
|
1809
|
+
* <li>
|
|
1810
|
+
* <p>
|
|
1811
|
+
* <code>BEGINS_WITH</code>: When you specify <code>BEGINS_WITH</code> for
|
|
1812
|
+
* <code>Condition</code>, you can specify only one value. <code>BEGINS_WITH</code> is supported
|
|
1813
|
+
* for <code>TYPE</code>, <code>NAME</code>, and <code>HTTP_NAME</code>.</p>
|
|
1814
|
+
* </li>
|
|
1815
|
+
* </ul>
|
|
1692
1816
|
*/
|
|
1693
1817
|
Condition?: FilterCondition | string;
|
|
1694
1818
|
}
|
|
1695
1819
|
export interface ListNamespacesRequest {
|
|
1696
1820
|
/**
|
|
1697
1821
|
* <p>For the first <code>ListNamespaces</code> request, omit this value.</p>
|
|
1698
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
1699
|
-
* next group of results. Specify the value of <code>NextToken</code> from the
|
|
1700
|
-
* request.</p>
|
|
1822
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
1823
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
1824
|
+
* previous response in the next request.</p>
|
|
1701
1825
|
* <note>
|
|
1702
|
-
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
1703
|
-
* possible that no namespaces in the first <code>MaxResults</code>
|
|
1704
|
-
* subsequent groups of <code>MaxResults</code>
|
|
1826
|
+
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
1827
|
+
* specified criteria. It's possible that no namespaces in the first <code>MaxResults</code>
|
|
1828
|
+
* namespaces matched the specified criteria but that subsequent groups of <code>MaxResults</code>
|
|
1829
|
+
* namespaces do contain namespaces that match the criteria.</p>
|
|
1705
1830
|
* </note>
|
|
1706
1831
|
*/
|
|
1707
1832
|
NextToken?: string;
|
|
1708
1833
|
/**
|
|
1709
1834
|
* <p>The maximum number of namespaces that you want Cloud Map to return in the response to a
|
|
1710
|
-
* <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
1711
|
-
* to 100 namespaces.</p>
|
|
1835
|
+
* <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
1836
|
+
* Cloud Map returns up to 100 namespaces.</p>
|
|
1712
1837
|
*/
|
|
1713
1838
|
MaxResults?: number;
|
|
1714
1839
|
/**
|
|
@@ -1731,8 +1856,8 @@ export interface NamespaceSummary {
|
|
|
1731
1856
|
*/
|
|
1732
1857
|
Arn?: string;
|
|
1733
1858
|
/**
|
|
1734
|
-
* <p>The name of the namespace. When you create a namespace, Cloud Map automatically creates a
|
|
1735
|
-
* that has the same name as the namespace.</p>
|
|
1859
|
+
* <p>The name of the namespace. When you create a namespace, Cloud Map automatically creates a
|
|
1860
|
+
* Route 53 hosted zone that has the same name as the namespace.</p>
|
|
1736
1861
|
*/
|
|
1737
1862
|
Name?: string;
|
|
1738
1863
|
/**
|
|
@@ -1758,18 +1883,19 @@ export interface NamespaceSummary {
|
|
|
1758
1883
|
}
|
|
1759
1884
|
export interface ListNamespacesResponse {
|
|
1760
1885
|
/**
|
|
1761
|
-
* <p>An array that contains one <code>NamespaceSummary</code> object for each namespace that
|
|
1762
|
-
* filter criteria.</p>
|
|
1886
|
+
* <p>An array that contains one <code>NamespaceSummary</code> object for each namespace that
|
|
1887
|
+
* matches the specified filter criteria.</p>
|
|
1763
1888
|
*/
|
|
1764
1889
|
Namespaces?: NamespaceSummary[];
|
|
1765
1890
|
/**
|
|
1766
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
1767
|
-
* next group of results. Specify the value of <code>NextToken</code> from the
|
|
1768
|
-
* request.</p>
|
|
1891
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code>
|
|
1892
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
1893
|
+
* previous response in the next request.</p>
|
|
1769
1894
|
* <note>
|
|
1770
|
-
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
1771
|
-
* possible that no namespaces in the first <code>MaxResults</code>
|
|
1772
|
-
* subsequent groups of <code>MaxResults</code>
|
|
1895
|
+
* <p>Cloud Map gets <code>MaxResults</code> namespaces and then filters them based on the
|
|
1896
|
+
* specified criteria. It's possible that no namespaces in the first <code>MaxResults</code>
|
|
1897
|
+
* namespaces matched the specified criteria but that subsequent groups of <code>MaxResults</code>
|
|
1898
|
+
* namespaces do contain namespaces that match the criteria.</p>
|
|
1773
1899
|
* </note>
|
|
1774
1900
|
*/
|
|
1775
1901
|
NextToken?: string;
|
|
@@ -1790,16 +1916,19 @@ export interface OperationFilter {
|
|
|
1790
1916
|
* <ul>
|
|
1791
1917
|
* <li>
|
|
1792
1918
|
* <p>
|
|
1793
|
-
* <b>NAMESPACE_ID</b>: Gets operations related to specified
|
|
1919
|
+
* <b>NAMESPACE_ID</b>: Gets operations related to specified
|
|
1920
|
+
* namespaces.</p>
|
|
1794
1921
|
* </li>
|
|
1795
1922
|
* <li>
|
|
1796
1923
|
* <p>
|
|
1797
|
-
* <b>SERVICE_ID</b>: Gets operations related to specified
|
|
1924
|
+
* <b>SERVICE_ID</b>: Gets operations related to specified
|
|
1925
|
+
* services.</p>
|
|
1798
1926
|
* </li>
|
|
1799
1927
|
* <li>
|
|
1800
1928
|
* <p>
|
|
1801
|
-
* <b>STATUS</b>: Gets operations based on the status of the
|
|
1802
|
-
*
|
|
1929
|
+
* <b>STATUS</b>: Gets operations based on the status of the
|
|
1930
|
+
* operations: <code>SUBMITTED</code>, <code>PENDING</code>, <code>SUCCEED</code>, or
|
|
1931
|
+
* <code>FAIL</code>.</p>
|
|
1803
1932
|
* </li>
|
|
1804
1933
|
* <li>
|
|
1805
1934
|
* <p>
|
|
@@ -1807,8 +1936,8 @@ export interface OperationFilter {
|
|
|
1807
1936
|
* </li>
|
|
1808
1937
|
* <li>
|
|
1809
1938
|
* <p>
|
|
1810
|
-
* <b>UPDATE_DATE</b>: Gets operations that changed status during a
|
|
1811
|
-
* range. </p>
|
|
1939
|
+
* <b>UPDATE_DATE</b>: Gets operations that changed status during a
|
|
1940
|
+
* specified date/time range. </p>
|
|
1812
1941
|
* </li>
|
|
1813
1942
|
* </ul>
|
|
1814
1943
|
*/
|
|
@@ -1826,8 +1955,9 @@ export interface OperationFilter {
|
|
|
1826
1955
|
* </li>
|
|
1827
1956
|
* <li>
|
|
1828
1957
|
* <p>
|
|
1829
|
-
* <b>STATUS</b>: Specify one or more statuses:
|
|
1830
|
-
* <code>
|
|
1958
|
+
* <b>STATUS</b>: Specify one or more statuses:
|
|
1959
|
+
* <code>SUBMITTED</code>, <code>PENDING</code>, <code>SUCCEED</code>, or
|
|
1960
|
+
* <code>FAIL</code>.</p>
|
|
1831
1961
|
* </li>
|
|
1832
1962
|
* <li>
|
|
1833
1963
|
* <p>
|
|
@@ -1837,33 +1967,36 @@ export interface OperationFilter {
|
|
|
1837
1967
|
* </li>
|
|
1838
1968
|
* <li>
|
|
1839
1969
|
* <p>
|
|
1840
|
-
* <b>UPDATE_DATE</b>: Specify a start date and an end date in Unix
|
|
1841
|
-
* and Coordinated Universal Time (UTC). The start date must be the first
|
|
1970
|
+
* <b>UPDATE_DATE</b>: Specify a start date and an end date in Unix
|
|
1971
|
+
* date/time format and Coordinated Universal Time (UTC). The start date must be the first
|
|
1972
|
+
* value.</p>
|
|
1842
1973
|
* </li>
|
|
1843
1974
|
* </ul>
|
|
1844
1975
|
*/
|
|
1845
1976
|
Values: string[] | undefined;
|
|
1846
1977
|
/**
|
|
1847
|
-
* <p>The operator that you want to use to determine whether an operation matches the specified
|
|
1848
|
-
* for condition include:</p>
|
|
1978
|
+
* <p>The operator that you want to use to determine whether an operation matches the specified
|
|
1979
|
+
* value. Valid values for condition include:</p>
|
|
1849
1980
|
* <ul>
|
|
1850
1981
|
* <li>
|
|
1851
1982
|
* <p>
|
|
1852
|
-
* <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only
|
|
1853
|
-
*
|
|
1854
|
-
* <code>TYPE</code>. <code>EQ</code> is the default condition and can
|
|
1983
|
+
* <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only
|
|
1984
|
+
* one value. <code>EQ</code> is supported for <code>NAMESPACE_ID</code>, <code>SERVICE_ID</code>,
|
|
1985
|
+
* <code>STATUS</code>, and <code>TYPE</code>. <code>EQ</code> is the default condition and can
|
|
1986
|
+
* be omitted.</p>
|
|
1855
1987
|
* </li>
|
|
1856
1988
|
* <li>
|
|
1857
1989
|
* <p>
|
|
1858
|
-
* <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a
|
|
1859
|
-
* values. <code>IN</code> is supported for <code>STATUS</code> and
|
|
1860
|
-
*
|
|
1990
|
+
* <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a
|
|
1991
|
+
* list of one or more values. <code>IN</code> is supported for <code>STATUS</code> and
|
|
1992
|
+
* <code>TYPE</code>. An operation must match one of the specified values to be returned in the
|
|
1993
|
+
* response.</p>
|
|
1861
1994
|
* </li>
|
|
1862
1995
|
* <li>
|
|
1863
1996
|
* <p>
|
|
1864
|
-
* <code>BETWEEN</code>: Specify a start date and an end date in Unix date/time format and
|
|
1865
|
-
* Time (UTC). The start date must be the first value. <code>BETWEEN</code>
|
|
1866
|
-
*
|
|
1997
|
+
* <code>BETWEEN</code>: Specify a start date and an end date in Unix date/time format and
|
|
1998
|
+
* Coordinated Universal Time (UTC). The start date must be the first value. <code>BETWEEN</code>
|
|
1999
|
+
* is supported for <code>UPDATE_DATE</code>. </p>
|
|
1867
2000
|
* </li>
|
|
1868
2001
|
* </ul>
|
|
1869
2002
|
*/
|
|
@@ -1872,33 +2005,34 @@ export interface OperationFilter {
|
|
|
1872
2005
|
export interface ListOperationsRequest {
|
|
1873
2006
|
/**
|
|
1874
2007
|
* <p>For the first <code>ListOperations</code> request, omit this value.</p>
|
|
1875
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
1876
|
-
* next group of results. Specify the value of <code>NextToken</code> from the
|
|
1877
|
-
* request.</p>
|
|
2008
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
2009
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2010
|
+
* previous response in the next request.</p>
|
|
1878
2011
|
* <note>
|
|
1879
|
-
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
1880
|
-
* possible that no operations in the first <code>MaxResults</code>
|
|
1881
|
-
* subsequent groups of <code>MaxResults</code>
|
|
2012
|
+
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
2013
|
+
* specified criteria. It's possible that no operations in the first <code>MaxResults</code>
|
|
2014
|
+
* operations matched the specified criteria but that subsequent groups of <code>MaxResults</code>
|
|
2015
|
+
* operations do contain operations that match the criteria.</p>
|
|
1882
2016
|
* </note>
|
|
1883
2017
|
*/
|
|
1884
2018
|
NextToken?: string;
|
|
1885
2019
|
/**
|
|
1886
|
-
* <p>The maximum number of items that you want Cloud Map to return in the response to a
|
|
1887
|
-
*
|
|
2020
|
+
* <p>The maximum number of items that you want Cloud Map to return in the response to a
|
|
2021
|
+
* <code>ListOperations</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2022
|
+
* Cloud Map returns up to 100 operations.</p>
|
|
1888
2023
|
*/
|
|
1889
2024
|
MaxResults?: number;
|
|
1890
2025
|
/**
|
|
1891
|
-
* <p>A complex type that contains specifications for the operations that you want to list, for
|
|
1892
|
-
* that you started between a specified start date and end date.</p>
|
|
2026
|
+
* <p>A complex type that contains specifications for the operations that you want to list, for
|
|
2027
|
+
* example, operations that you started between a specified start date and end date.</p>
|
|
1893
2028
|
* <p>If you specify more than one filter, an operation must match all filters to be returned by
|
|
1894
2029
|
* <code>ListOperations</code>.</p>
|
|
1895
2030
|
*/
|
|
1896
2031
|
Filters?: OperationFilter[];
|
|
1897
2032
|
}
|
|
1898
2033
|
/**
|
|
1899
|
-
* <p>A complex type that contains information about an operation that matches the criteria that
|
|
1900
|
-
*
|
|
1901
|
-
* request.</p>
|
|
2034
|
+
* <p>A complex type that contains information about an operation that matches the criteria that
|
|
2035
|
+
* you specified in a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html">ListOperations</a> request.</p>
|
|
1902
2036
|
*/
|
|
1903
2037
|
export interface OperationSummary {
|
|
1904
2038
|
/**
|
|
@@ -1910,8 +2044,8 @@ export interface OperationSummary {
|
|
|
1910
2044
|
* <ul>
|
|
1911
2045
|
* <li>
|
|
1912
2046
|
* <p>
|
|
1913
|
-
* <b>SUBMITTED</b>: This is the initial state immediately after
|
|
1914
|
-
* request.</p>
|
|
2047
|
+
* <b>SUBMITTED</b>: This is the initial state immediately after
|
|
2048
|
+
* you submit a request.</p>
|
|
1915
2049
|
* </li>
|
|
1916
2050
|
* <li>
|
|
1917
2051
|
* <p>
|
|
@@ -1936,13 +2070,14 @@ export interface ListOperationsResponse {
|
|
|
1936
2070
|
*/
|
|
1937
2071
|
Operations?: OperationSummary[];
|
|
1938
2072
|
/**
|
|
1939
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
1940
|
-
* next group of results. Specify the value of <code>NextToken</code> from the
|
|
1941
|
-
* request.</p>
|
|
2073
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code>
|
|
2074
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2075
|
+
* previous response in the next request.</p>
|
|
1942
2076
|
* <note>
|
|
1943
|
-
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
1944
|
-
* possible that no operations in the first <code>MaxResults</code>
|
|
1945
|
-
* subsequent groups of <code>MaxResults</code>
|
|
2077
|
+
* <p>Cloud Map gets <code>MaxResults</code> operations and then filters them based on the
|
|
2078
|
+
* specified criteria. It's possible that no operations in the first <code>MaxResults</code>
|
|
2079
|
+
* operations matched the specified criteria but that subsequent groups of <code>MaxResults</code>
|
|
2080
|
+
* operations do contain operations that match the criteria.</p>
|
|
1946
2081
|
* </note>
|
|
1947
2082
|
*/
|
|
1948
2083
|
NextToken?: string;
|
|
@@ -1951,7 +2086,8 @@ export declare enum ServiceFilterName {
|
|
|
1951
2086
|
NAMESPACE_ID = "NAMESPACE_ID"
|
|
1952
2087
|
}
|
|
1953
2088
|
/**
|
|
1954
|
-
* <p>A complex type that lets you specify the namespaces that you want to list services
|
|
2089
|
+
* <p>A complex type that lets you specify the namespaces that you want to list services
|
|
2090
|
+
* for.</p>
|
|
1955
2091
|
*/
|
|
1956
2092
|
export interface ServiceFilter {
|
|
1957
2093
|
/**
|
|
@@ -1959,27 +2095,18 @@ export interface ServiceFilter {
|
|
|
1959
2095
|
*/
|
|
1960
2096
|
Name: ServiceFilterName | string | undefined;
|
|
1961
2097
|
/**
|
|
1962
|
-
* <p>The values that are applicable to the value that you specify for <code>Condition</code> to
|
|
1963
|
-
* services.</p>
|
|
2098
|
+
* <p>The values that are applicable to the value that you specify for <code>Condition</code> to
|
|
2099
|
+
* filter the list of services.</p>
|
|
1964
2100
|
*/
|
|
1965
2101
|
Values: string[] | undefined;
|
|
1966
2102
|
/**
|
|
1967
|
-
* <p>The operator that you want to use to determine whether a service is returned by
|
|
1968
|
-
*
|
|
2103
|
+
* <p>The operator that you want to use to determine whether a service is returned by
|
|
2104
|
+
* <code>ListServices</code>. Valid values for <code>Condition</code> include the following:</p>
|
|
1969
2105
|
* <ul>
|
|
1970
2106
|
* <li>
|
|
1971
2107
|
* <p>
|
|
1972
|
-
* <code>EQ</code>: When you specify <code>EQ</code>, specify one namespace ID for
|
|
1973
|
-
* <code>EQ</code> is the default condition and can be omitted.</p>
|
|
1974
|
-
* </li>
|
|
1975
|
-
* <li>
|
|
1976
|
-
* <p>
|
|
1977
|
-
* <code>IN</code>: When you specify <code>IN</code>, specify a list of the IDs for the namespaces that you want
|
|
1978
|
-
* <code>ListServices</code> to return a list of services for.</p>
|
|
1979
|
-
* </li>
|
|
1980
|
-
* <li>
|
|
1981
|
-
* <p>
|
|
1982
|
-
* <code>BETWEEN</code>: Not applicable.</p>
|
|
2108
|
+
* <code>EQ</code>: When you specify <code>EQ</code>, specify one namespace ID for
|
|
2109
|
+
* <code>Values</code>. <code>EQ</code> is the default condition and can be omitted.</p>
|
|
1983
2110
|
* </li>
|
|
1984
2111
|
* </ul>
|
|
1985
2112
|
*/
|
|
@@ -1988,23 +2115,26 @@ export interface ServiceFilter {
|
|
|
1988
2115
|
export interface ListServicesRequest {
|
|
1989
2116
|
/**
|
|
1990
2117
|
* <p>For the first <code>ListServices</code> request, omit this value.</p>
|
|
1991
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
1992
|
-
* next group of results. Specify the value of <code>NextToken</code> from the
|
|
1993
|
-
* request.</p>
|
|
2118
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2119
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2120
|
+
* previous response in the next request.</p>
|
|
1994
2121
|
* <note>
|
|
1995
|
-
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
1996
|
-
* possible that no services in the first <code>MaxResults</code> services
|
|
1997
|
-
* subsequent groups of <code>MaxResults</code> services do
|
|
2122
|
+
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2123
|
+
* specified criteria. It's possible that no services in the first <code>MaxResults</code> services
|
|
2124
|
+
* matched the specified criteria but that subsequent groups of <code>MaxResults</code> services do
|
|
2125
|
+
* contain services that match the criteria.</p>
|
|
1998
2126
|
* </note>
|
|
1999
2127
|
*/
|
|
2000
2128
|
NextToken?: string;
|
|
2001
2129
|
/**
|
|
2002
|
-
* <p>The maximum number of services that you want Cloud Map to return in the response to a
|
|
2003
|
-
*
|
|
2130
|
+
* <p>The maximum number of services that you want Cloud Map to return in the response to a
|
|
2131
|
+
* <code>ListServices</code> request. If you don't specify a value for <code>MaxResults</code>,
|
|
2132
|
+
* Cloud Map returns up to 100 services.</p>
|
|
2004
2133
|
*/
|
|
2005
2134
|
MaxResults?: number;
|
|
2006
2135
|
/**
|
|
2007
|
-
* <p>A complex type that contains specifications for the namespaces that you want to list
|
|
2136
|
+
* <p>A complex type that contains specifications for the namespaces that you want to list
|
|
2137
|
+
* services for. </p>
|
|
2008
2138
|
* <p>If you specify more than one filter, an operation must match all filters to be returned by
|
|
2009
2139
|
* <code>ListServices</code>.</p>
|
|
2010
2140
|
*/
|
|
@@ -2031,12 +2161,13 @@ export interface ServiceSummary {
|
|
|
2031
2161
|
* <dl>
|
|
2032
2162
|
* <dt>DNS_HTTP</dt>
|
|
2033
2163
|
* <dd>
|
|
2034
|
-
* <p>The service instances can be discovered using either DNS queries or the
|
|
2035
|
-
*
|
|
2164
|
+
* <p>The service instances can be discovered using either DNS queries or the
|
|
2165
|
+
* <code>DiscoverInstances</code> API operation.</p>
|
|
2036
2166
|
* </dd>
|
|
2037
2167
|
* <dt>HTTP</dt>
|
|
2038
2168
|
* <dd>
|
|
2039
|
-
* <p>The service instances can only be discovered using the <code>DiscoverInstances</code> API
|
|
2169
|
+
* <p>The service instances can only be discovered using the <code>DiscoverInstances</code> API
|
|
2170
|
+
* operation.</p>
|
|
2040
2171
|
* </dd>
|
|
2041
2172
|
* <dt>DNS</dt>
|
|
2042
2173
|
* <dd>
|
|
@@ -2050,38 +2181,42 @@ export interface ServiceSummary {
|
|
|
2050
2181
|
*/
|
|
2051
2182
|
Description?: string;
|
|
2052
2183
|
/**
|
|
2053
|
-
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
2054
|
-
* associated with the service but that are deleted aren't included in the count. The
|
|
2055
|
-
* registrations and deregistrations.</p>
|
|
2184
|
+
* <p>The number of instances that are currently associated with the service. Instances that were
|
|
2185
|
+
* previously associated with the service but that are deleted aren't included in the count. The
|
|
2186
|
+
* count might not reflect pending registrations and deregistrations.</p>
|
|
2056
2187
|
*/
|
|
2057
2188
|
InstanceCount?: number;
|
|
2058
2189
|
/**
|
|
2059
|
-
* <p>Information about the Route
|
|
2190
|
+
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
|
|
2191
|
+
* an instance.</p>
|
|
2060
2192
|
*/
|
|
2061
2193
|
DnsConfig?: DnsConfig;
|
|
2062
2194
|
/**
|
|
2063
2195
|
* <p>
|
|
2064
|
-
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
2065
|
-
* settings for a health check, Cloud Map associates the health check with
|
|
2066
|
-
*
|
|
2196
|
+
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
2197
|
+
* check. If you specify settings for a health check, Cloud Map associates the health check with
|
|
2198
|
+
* the records that you specify in <code>DnsConfig</code>.</p>
|
|
2067
2199
|
*/
|
|
2068
2200
|
HealthCheckConfig?: HealthCheckConfig;
|
|
2069
2201
|
/**
|
|
2070
|
-
* <p>Information about an optional custom health check. A custom health check, which requires
|
|
2071
|
-
* third-party health checker to evaluate the health of your resources, is useful in
|
|
2202
|
+
* <p>Information about an optional custom health check. A custom health check, which requires
|
|
2203
|
+
* that you use a third-party health checker to evaluate the health of your resources, is useful in
|
|
2204
|
+
* the following circumstances:</p>
|
|
2072
2205
|
* <ul>
|
|
2073
2206
|
* <li>
|
|
2074
|
-
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
2075
|
-
* available over the internet. For example, you can use a custom health check when
|
|
2076
|
-
* (To check the health of resources in a VPC, the health
|
|
2207
|
+
* <p>You can't use a health check that's defined by <code>HealthCheckConfig</code> because the
|
|
2208
|
+
* resource isn't available over the internet. For example, you can use a custom health check when
|
|
2209
|
+
* the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health
|
|
2210
|
+
* checker must also be in the VPC.)</p>
|
|
2077
2211
|
* </li>
|
|
2078
2212
|
* <li>
|
|
2079
|
-
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
2213
|
+
* <p>You want to use a third-party health checker regardless of where your resources are
|
|
2214
|
+
* located.</p>
|
|
2080
2215
|
* </li>
|
|
2081
2216
|
* </ul>
|
|
2082
2217
|
* <important>
|
|
2083
|
-
* <p>If you specify a health check configuration, you can specify either
|
|
2084
|
-
* <code>HealthCheckConfig</code> but not both.</p>
|
|
2218
|
+
* <p>If you specify a health check configuration, you can specify either
|
|
2219
|
+
* <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p>
|
|
2085
2220
|
* </important>
|
|
2086
2221
|
*/
|
|
2087
2222
|
HealthCheckCustomConfig?: HealthCheckCustomConfig;
|
|
@@ -2092,18 +2227,19 @@ export interface ServiceSummary {
|
|
|
2092
2227
|
}
|
|
2093
2228
|
export interface ListServicesResponse {
|
|
2094
2229
|
/**
|
|
2095
|
-
* <p>An array that contains one <code>ServiceSummary</code> object for each service that matches
|
|
2096
|
-
* criteria.</p>
|
|
2230
|
+
* <p>An array that contains one <code>ServiceSummary</code> object for each service that matches
|
|
2231
|
+
* the specified filter criteria.</p>
|
|
2097
2232
|
*/
|
|
2098
2233
|
Services?: ServiceSummary[];
|
|
2099
2234
|
/**
|
|
2100
|
-
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2101
|
-
* next group of results. Specify the value of <code>NextToken</code> from the
|
|
2102
|
-
* request.</p>
|
|
2235
|
+
* <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code>
|
|
2236
|
+
* request to get the next group of results. Specify the value of <code>NextToken</code> from the
|
|
2237
|
+
* previous response in the next request.</p>
|
|
2103
2238
|
* <note>
|
|
2104
|
-
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2105
|
-
* possible that no services in the first <code>MaxResults</code> services
|
|
2106
|
-
* subsequent groups of <code>MaxResults</code> services do
|
|
2239
|
+
* <p>Cloud Map gets <code>MaxResults</code> services and then filters them based on the
|
|
2240
|
+
* specified criteria. It's possible that no services in the first <code>MaxResults</code> services
|
|
2241
|
+
* matched the specified criteria but that subsequent groups of <code>MaxResults</code> services do
|
|
2242
|
+
* contain services that match the criteria.</p>
|
|
2107
2243
|
* </note>
|
|
2108
2244
|
*/
|
|
2109
2245
|
NextToken?: string;
|
|
@@ -2133,89 +2269,91 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
2133
2269
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
2134
2270
|
}
|
|
2135
2271
|
/**
|
|
2136
|
-
* <p>Updated Start of
|
|
2137
|
-
* properties for a public or private DNS namespace.</p>
|
|
2272
|
+
* <p>Updated Start of
|
|
2273
|
+
* Authority (SOA) properties for a public or private DNS namespace.</p>
|
|
2138
2274
|
*/
|
|
2139
2275
|
export interface SOAChange {
|
|
2140
2276
|
/**
|
|
2141
|
-
* <p>The updated time to
|
|
2142
|
-
* purposes of negative caching.</p>
|
|
2277
|
+
* <p>The updated time to
|
|
2278
|
+
* live (TTL) for purposes of negative caching.</p>
|
|
2143
2279
|
*/
|
|
2144
2280
|
TTL: number | undefined;
|
|
2145
2281
|
}
|
|
2146
2282
|
/**
|
|
2147
|
-
* <p>Updated DNS
|
|
2148
|
-
* DNS namespace.</p>
|
|
2283
|
+
* <p>Updated DNS
|
|
2284
|
+
* properties for the private DNS namespace.</p>
|
|
2149
2285
|
*/
|
|
2150
2286
|
export interface PrivateDnsPropertiesMutableChange {
|
|
2151
2287
|
/**
|
|
2152
|
-
* <p>Updated fields for
|
|
2153
|
-
* (SOA) record for the hosted zone for the private DNS
|
|
2288
|
+
* <p>Updated fields for
|
|
2289
|
+
* the Start of Authority (SOA) record for the hosted zone for the private DNS
|
|
2290
|
+
* namespace.</p>
|
|
2154
2291
|
*/
|
|
2155
2292
|
SOA: SOAChange | undefined;
|
|
2156
2293
|
}
|
|
2157
2294
|
/**
|
|
2158
|
-
* <p>Updated properties
|
|
2159
|
-
* namespace.</p>
|
|
2295
|
+
* <p>Updated properties
|
|
2296
|
+
* for the private DNS namespace.</p>
|
|
2160
2297
|
*/
|
|
2161
2298
|
export interface PrivateDnsNamespacePropertiesChange {
|
|
2162
2299
|
/**
|
|
2163
|
-
* <p>Updated DNS
|
|
2164
|
-
* DNS namespace.</p>
|
|
2300
|
+
* <p>Updated DNS
|
|
2301
|
+
* properties for the private DNS namespace.</p>
|
|
2165
2302
|
*/
|
|
2166
2303
|
DnsProperties: PrivateDnsPropertiesMutableChange | undefined;
|
|
2167
2304
|
}
|
|
2168
2305
|
/**
|
|
2169
|
-
* <p>Updated properties
|
|
2170
|
-
* namespace.</p>
|
|
2306
|
+
* <p>Updated properties
|
|
2307
|
+
* for the private DNS namespace.</p>
|
|
2171
2308
|
*/
|
|
2172
2309
|
export interface PrivateDnsNamespaceChange {
|
|
2173
2310
|
/**
|
|
2174
|
-
* <p>An updated
|
|
2175
|
-
* DNS namespace.</p>
|
|
2311
|
+
* <p>An updated
|
|
2312
|
+
* description for the private DNS namespace.</p>
|
|
2176
2313
|
*/
|
|
2177
2314
|
Description?: string;
|
|
2178
2315
|
/**
|
|
2179
|
-
* <p>Properties to be
|
|
2180
|
-
* DNS namespace.</p>
|
|
2316
|
+
* <p>Properties to be
|
|
2317
|
+
* updated in the private DNS namespace.</p>
|
|
2181
2318
|
*/
|
|
2182
2319
|
Properties?: PrivateDnsNamespacePropertiesChange;
|
|
2183
2320
|
}
|
|
2184
2321
|
/**
|
|
2185
|
-
* <p>Updated DNS
|
|
2186
|
-
* namespace.</p>
|
|
2322
|
+
* <p>Updated DNS
|
|
2323
|
+
* properties for the public DNS namespace.</p>
|
|
2187
2324
|
*/
|
|
2188
2325
|
export interface PublicDnsPropertiesMutableChange {
|
|
2189
2326
|
/**
|
|
2190
|
-
* <p>Updated fields for
|
|
2191
|
-
* (SOA) record for the hosted zone for the public DNS
|
|
2327
|
+
* <p>Updated fields for
|
|
2328
|
+
* the Start of Authority (SOA) record for the hosted zone for the public DNS
|
|
2329
|
+
* namespace.</p>
|
|
2192
2330
|
*/
|
|
2193
2331
|
SOA: SOAChange | undefined;
|
|
2194
2332
|
}
|
|
2195
2333
|
/**
|
|
2196
|
-
* <p>Updated properties
|
|
2197
|
-
* namespace.</p>
|
|
2334
|
+
* <p>Updated properties
|
|
2335
|
+
* for the public DNS namespace.</p>
|
|
2198
2336
|
*/
|
|
2199
2337
|
export interface PublicDnsNamespacePropertiesChange {
|
|
2200
2338
|
/**
|
|
2201
|
-
* <p>Updated DNS
|
|
2202
|
-
* zone for the public DNS namespace.</p>
|
|
2339
|
+
* <p>Updated DNS
|
|
2340
|
+
* properties for the hosted zone for the public DNS namespace.</p>
|
|
2203
2341
|
*/
|
|
2204
2342
|
DnsProperties: PublicDnsPropertiesMutableChange | undefined;
|
|
2205
2343
|
}
|
|
2206
2344
|
/**
|
|
2207
|
-
* <p>Updated properties
|
|
2208
|
-
* namespace.</p>
|
|
2345
|
+
* <p>Updated properties
|
|
2346
|
+
* for the public DNS namespace.</p>
|
|
2209
2347
|
*/
|
|
2210
2348
|
export interface PublicDnsNamespaceChange {
|
|
2211
2349
|
/**
|
|
2212
|
-
* <p>An updated
|
|
2213
|
-
* namespace.</p>
|
|
2350
|
+
* <p>An updated
|
|
2351
|
+
* description for the public DNS namespace.</p>
|
|
2214
2352
|
*/
|
|
2215
2353
|
Description?: string;
|
|
2216
2354
|
/**
|
|
2217
|
-
* <p>Properties to be
|
|
2218
|
-
* DNS namespace.</p>
|
|
2355
|
+
* <p>Properties to be
|
|
2356
|
+
* updated in the public DNS namespace.</p>
|
|
2219
2357
|
*/
|
|
2220
2358
|
Properties?: PublicDnsNamespacePropertiesChange;
|
|
2221
2359
|
}
|
|
@@ -2228,40 +2366,48 @@ export interface RegisterInstanceRequest {
|
|
|
2228
2366
|
* <p>An identifier that you want to associate with the instance. Note the following:</p>
|
|
2229
2367
|
* <ul>
|
|
2230
2368
|
* <li>
|
|
2231
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
2232
|
-
*
|
|
2233
|
-
* record. For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type">DnsRecord >
|
|
2369
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes settings for an
|
|
2370
|
+
* <code>SRV</code> record, the value of <code>InstanceId</code> is automatically included as
|
|
2371
|
+
* 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 >
|
|
2372
|
+
* Type</a>.</p>
|
|
2234
2373
|
* </li>
|
|
2235
2374
|
* <li>
|
|
2236
2375
|
* <p>You can use this value to update an existing instance.</p>
|
|
2237
2376
|
* </li>
|
|
2238
2377
|
* <li>
|
|
2239
|
-
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
2240
|
-
* the same service. </p>
|
|
2378
|
+
* <p>To register a new instance, you must specify a value that's unique among instances that
|
|
2379
|
+
* you register by using the same service. </p>
|
|
2241
2380
|
* </li>
|
|
2242
2381
|
* <li>
|
|
2243
|
-
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
2244
|
-
* DNS records, if any. If there's also an existing health check, Cloud Map
|
|
2245
|
-
* a new one. </p>
|
|
2382
|
+
* <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Cloud Map
|
|
2383
|
+
* updates the existing DNS records, if any. If there's also an existing health check, Cloud Map
|
|
2384
|
+
* deletes the old health check and creates a new one. </p>
|
|
2246
2385
|
* <note>
|
|
2247
|
-
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
2248
|
-
*
|
|
2386
|
+
* <p>The health check isn't deleted immediately, so it will still appear for a while if you
|
|
2387
|
+
* submit a <code>ListHealthChecks</code> request, for example.</p>
|
|
2249
2388
|
* </note>
|
|
2250
2389
|
* </li>
|
|
2251
2390
|
* </ul>
|
|
2391
|
+
*
|
|
2392
|
+
* <note>
|
|
2393
|
+
* <p>Do not include sensitive information in <code>InstanceId</code> if the namespace is discoverable by public DNS
|
|
2394
|
+
* queries and any <code>Type</code> member of <code>DnsRecord</code> for the service contains <code>SRV</code> because
|
|
2395
|
+
* the <code>InstanceId</code> is discoverable by public DNS queries.</p>
|
|
2396
|
+
* </note>
|
|
2252
2397
|
*/
|
|
2253
2398
|
InstanceId: string | undefined;
|
|
2254
2399
|
/**
|
|
2255
|
-
* <p>A unique string that identifies the request and that allows failed
|
|
2256
|
-
*
|
|
2257
|
-
*
|
|
2258
|
-
*
|
|
2259
|
-
*
|
|
2400
|
+
* <p>A unique string that identifies the request and that allows failed
|
|
2401
|
+
* <code>RegisterInstance</code> requests to be retried without the risk of executing the operation
|
|
2402
|
+
* twice. You must use a unique <code>CreatorRequestId</code> string every time you submit a
|
|
2403
|
+
* <code>RegisterInstance</code> request if you're registering additional instances for the same
|
|
2404
|
+
* namespace and service. <code>CreatorRequestId</code> can be any unique string (for example, a
|
|
2405
|
+
* date/time stamp).</p>
|
|
2260
2406
|
*/
|
|
2261
2407
|
CreatorRequestId?: string;
|
|
2262
2408
|
/**
|
|
2263
2409
|
* <p>A string map that contains the following information for the service that you specify in
|
|
2264
|
-
*
|
|
2410
|
+
* <code>ServiceId</code>:</p>
|
|
2265
2411
|
* <ul>
|
|
2266
2412
|
* <li>
|
|
2267
2413
|
* <p>The attributes that apply to the records that are defined in the service. </p>
|
|
@@ -2270,35 +2416,41 @@ export interface RegisterInstanceRequest {
|
|
|
2270
2416
|
* <p>For each attribute, the applicable value.</p>
|
|
2271
2417
|
* </li>
|
|
2272
2418
|
* </ul>
|
|
2419
|
+
*
|
|
2420
|
+
* <note>
|
|
2421
|
+
* <p>Do not include sensitive information in the attributes if the namespace is discoverable by public DNS
|
|
2422
|
+
* queries.</p>
|
|
2423
|
+
* </note>
|
|
2424
|
+
*
|
|
2273
2425
|
* <p>Supported attribute keys include the following:</p>
|
|
2274
2426
|
* <dl>
|
|
2275
2427
|
* <dt>AWS_ALIAS_DNS_NAME</dt>
|
|
2276
2428
|
* <dd>
|
|
2277
|
-
* <p>If you want Cloud Map to create an Amazon Route
|
|
2278
|
-
* specify the DNS name that's associated with the load balancer. For
|
|
2279
|
-
* "DNSName" in the topic <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html">AliasTarget</a> in the <i>Route
|
|
2429
|
+
* <p>If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an
|
|
2430
|
+
* Elastic Load Balancing load balancer, specify the DNS name that's associated with the load balancer. For
|
|
2431
|
+
* 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>
|
|
2280
2432
|
* <p>Note the following:</p>
|
|
2281
2433
|
* <ul>
|
|
2282
2434
|
* <li>
|
|
2283
|
-
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
2284
|
-
*
|
|
2435
|
+
* <p>The configuration for the service that's specified by <code>ServiceId</code> must
|
|
2436
|
+
* include settings for an <code>A</code> record, an <code>AAAA</code> record, or both.</p>
|
|
2285
2437
|
* </li>
|
|
2286
2438
|
* <li>
|
|
2287
|
-
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
2288
|
-
* <code>WEIGHTED</code>.</p>
|
|
2439
|
+
* <p>In the service that's specified by <code>ServiceId</code>, the value of
|
|
2440
|
+
* <code>RoutingPolicy</code> must be <code>WEIGHTED</code>.</p>
|
|
2289
2441
|
* </li>
|
|
2290
2442
|
* <li>
|
|
2291
|
-
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
2292
|
-
*
|
|
2293
|
-
* record.</p>
|
|
2443
|
+
* <p>If the service that's specified by <code>ServiceId</code> includes
|
|
2444
|
+
* <code>HealthCheckConfig</code> settings, Cloud Map will create the Route 53 health check, but
|
|
2445
|
+
* it doesn't associate the health check with the alias record.</p>
|
|
2294
2446
|
* </li>
|
|
2295
2447
|
* <li>
|
|
2296
|
-
* <p>Auto naming currently doesn't support creating alias records that route traffic to
|
|
2297
|
-
*
|
|
2448
|
+
* <p>Auto naming currently doesn't support creating alias records that route traffic to
|
|
2449
|
+
* Amazon Web Services resources other than Elastic Load Balancing load balancers.</p>
|
|
2298
2450
|
* </li>
|
|
2299
2451
|
* <li>
|
|
2300
|
-
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
2301
|
-
*
|
|
2452
|
+
* <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for
|
|
2453
|
+
* any of the <code>AWS_INSTANCE</code> attributes.</p>
|
|
2302
2454
|
* </li>
|
|
2303
2455
|
* </ul>
|
|
2304
2456
|
* </dd>
|
|
@@ -2306,54 +2458,61 @@ export interface RegisterInstanceRequest {
|
|
|
2306
2458
|
* <dd>
|
|
2307
2459
|
* <p>
|
|
2308
2460
|
* <i>HTTP namespaces only.</i> The Amazon EC2 instance ID for the instance. If the
|
|
2309
|
-
* <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the only other attribute that
|
|
2310
|
-
*
|
|
2311
|
-
* <code>
|
|
2461
|
+
* <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the only other attribute that
|
|
2462
|
+
* can be specified is <code>AWS_INIT_HEALTH_STATUS</code>. When the
|
|
2463
|
+
* <code>AWS_EC2_INSTANCE_ID</code> attribute is specified, then the
|
|
2464
|
+
* <code>AWS_INSTANCE_IPV4</code> attribute will be filled out with the primary private IPv4
|
|
2465
|
+
* address.</p>
|
|
2312
2466
|
* </dd>
|
|
2313
2467
|
* <dt>AWS_INIT_HEALTH_STATUS</dt>
|
|
2314
2468
|
* <dd>
|
|
2315
|
-
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
2316
|
-
*
|
|
2317
|
-
*
|
|
2469
|
+
* <p>If the service configuration includes <code>HealthCheckCustomConfig</code>, you can
|
|
2470
|
+
* optionally use <code>AWS_INIT_HEALTH_STATUS</code> to specify the initial status of the custom
|
|
2471
|
+
* health check, <code>HEALTHY</code> or <code>UNHEALTHY</code>. If you don't specify a value for
|
|
2318
2472
|
* <code>AWS_INIT_HEALTH_STATUS</code>, the initial status is <code>HEALTHY</code>.</p>
|
|
2319
2473
|
* </dd>
|
|
2320
2474
|
* <dt>AWS_INSTANCE_CNAME</dt>
|
|
2321
2475
|
* <dd>
|
|
2322
|
-
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
2323
|
-
* return in response to DNS queries (for example,
|
|
2324
|
-
*
|
|
2325
|
-
*
|
|
2476
|
+
* <p>If the service configuration includes a <code>CNAME</code> record, the domain name that
|
|
2477
|
+
* you want Route 53 to return in response to DNS queries (for example,
|
|
2478
|
+
* <code>example.com</code>).</p>
|
|
2479
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
2480
|
+
* settings for an <code>CNAME</code> record.</p>
|
|
2326
2481
|
* </dd>
|
|
2327
2482
|
* <dt>AWS_INSTANCE_IPV4</dt>
|
|
2328
2483
|
* <dd>
|
|
2329
|
-
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
2330
|
-
* return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
2331
|
-
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
2332
|
-
*
|
|
2333
|
-
*
|
|
2484
|
+
* <p>If the service configuration includes an <code>A</code> record, the IPv4 address that you
|
|
2485
|
+
* want Route 53 to return in response to DNS queries (for example, <code>192.0.2.44</code>).</p>
|
|
2486
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
2487
|
+
* settings for an <code>A</code> record. If the service includes settings for an
|
|
2488
|
+
* <code>SRV</code> record, you must specify a value for <code>AWS_INSTANCE_IPV4</code>,
|
|
2489
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
2334
2490
|
* </dd>
|
|
2335
2491
|
* <dt>AWS_INSTANCE_IPV6</dt>
|
|
2336
2492
|
* <dd>
|
|
2337
|
-
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
2338
|
-
* return in response to DNS queries (for example,
|
|
2339
|
-
*
|
|
2340
|
-
*
|
|
2341
|
-
*
|
|
2493
|
+
* <p>If the service configuration includes an <code>AAAA</code> record, the IPv6 address that
|
|
2494
|
+
* you want Route 53 to return in response to DNS queries (for example,
|
|
2495
|
+
* <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>).</p>
|
|
2496
|
+
* <p>This value is required if the service specified by <code>ServiceId</code> includes
|
|
2497
|
+
* settings for an <code>AAAA</code> record. If the service includes settings for an
|
|
2498
|
+
* <code>SRV</code> record, you must specify a value for <code>AWS_INSTANCE_IPV4</code>,
|
|
2499
|
+
* <code>AWS_INSTANCE_IPV6</code>, or both.</p>
|
|
2342
2500
|
* </dd>
|
|
2343
2501
|
* <dt>AWS_INSTANCE_PORT</dt>
|
|
2344
2502
|
* <dd>
|
|
2345
|
-
* <p>If the service includes an <code>SRV</code> record, the value that you want Route
|
|
2346
|
-
* port.</p>
|
|
2347
|
-
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
2348
|
-
* requests to. </p>
|
|
2349
|
-
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
2350
|
-
* you created the service.</p>
|
|
2503
|
+
* <p>If the service includes an <code>SRV</code> record, the value that you want Route 53 to
|
|
2504
|
+
* return for the port.</p>
|
|
2505
|
+
* <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you
|
|
2506
|
+
* want Route 53 to send requests to. </p>
|
|
2507
|
+
* <p>This value is required if you specified settings for an <code>SRV</code> record or a
|
|
2508
|
+
* Route 53 health check when you created the service.</p>
|
|
2351
2509
|
* </dd>
|
|
2352
2510
|
* <dt>Custom attributes</dt>
|
|
2353
2511
|
* <dd>
|
|
2354
|
-
* <p>You can add up to 30 custom attributes. For each key-value pair, the maximum length of
|
|
2355
|
-
* 255 characters, and the maximum length of the attribute value is 1,024
|
|
2356
|
-
* attributes (sum of all keys and values) must not
|
|
2512
|
+
* <p>You can add up to 30 custom attributes. For each key-value pair, the maximum length of
|
|
2513
|
+
* the attribute name is 255 characters, and the maximum length of the attribute value is 1,024
|
|
2514
|
+
* characters. The total size of all provided attributes (sum of all keys and values) must not
|
|
2515
|
+
* exceed 5,000 characters.</p>
|
|
2357
2516
|
* </dd>
|
|
2358
2517
|
* </dl>
|
|
2359
2518
|
*/
|
|
@@ -2372,8 +2531,8 @@ export interface TagResourceRequest {
|
|
|
2372
2531
|
*/
|
|
2373
2532
|
ResourceARN: string | undefined;
|
|
2374
2533
|
/**
|
|
2375
|
-
* <p>The tags to add to the specified resource. Specifying the tag key is required. You can set
|
|
2376
|
-
* an empty string, but you can't set the value of a tag to null.</p>
|
|
2534
|
+
* <p>The tags to add to the specified resource. Specifying the tag key is required. You can set
|
|
2535
|
+
* the value of a tag to an empty string, but you can't set the value of a tag to null.</p>
|
|
2377
2536
|
*/
|
|
2378
2537
|
Tags: Tag[] | undefined;
|
|
2379
2538
|
}
|
|
@@ -2393,20 +2552,20 @@ export interface UntagResourceResponse {
|
|
|
2393
2552
|
}
|
|
2394
2553
|
export interface UpdateHttpNamespaceRequest {
|
|
2395
2554
|
/**
|
|
2396
|
-
* <p>The ID of the
|
|
2397
|
-
* update.</p>
|
|
2555
|
+
* <p>The ID of the
|
|
2556
|
+
* namespace that you want to update.</p>
|
|
2398
2557
|
*/
|
|
2399
2558
|
Id: string | undefined;
|
|
2400
2559
|
/**
|
|
2401
|
-
* <p>A unique string that
|
|
2402
|
-
* request and that allows failed <code>UpdateHttpNamespace</code> requests to be
|
|
2403
|
-
* the operation twice. <code>UpdaterRequestId</code> can be any
|
|
2404
|
-
* date/timestamp).</p>
|
|
2560
|
+
* <p>A unique string that
|
|
2561
|
+
* identifies the request and that allows failed <code>UpdateHttpNamespace</code> requests to be
|
|
2562
|
+
* retried without the risk of running the operation twice. <code>UpdaterRequestId</code> can be any
|
|
2563
|
+
* unique string (for example, a date/timestamp).</p>
|
|
2405
2564
|
*/
|
|
2406
2565
|
UpdaterRequestId?: string;
|
|
2407
2566
|
/**
|
|
2408
|
-
* <p>Updated properties
|
|
2409
|
-
* namespace.</p>
|
|
2567
|
+
* <p>Updated properties
|
|
2568
|
+
* for the the HTTP namespace.</p>
|
|
2410
2569
|
*/
|
|
2411
2570
|
Namespace: HttpNamespaceChange | undefined;
|
|
2412
2571
|
}
|
|
@@ -2419,8 +2578,8 @@ export interface UpdateHttpNamespaceResponse {
|
|
|
2419
2578
|
}
|
|
2420
2579
|
export interface UpdateInstanceCustomHealthStatusRequest {
|
|
2421
2580
|
/**
|
|
2422
|
-
* <p>The ID of the service that includes the configuration for the custom health check that you
|
|
2423
|
-
* status for.</p>
|
|
2581
|
+
* <p>The ID of the service that includes the configuration for the custom health check that you
|
|
2582
|
+
* want to change the status for.</p>
|
|
2424
2583
|
*/
|
|
2425
2584
|
ServiceId: string | undefined;
|
|
2426
2585
|
/**
|
|
@@ -2434,20 +2593,20 @@ export interface UpdateInstanceCustomHealthStatusRequest {
|
|
|
2434
2593
|
}
|
|
2435
2594
|
export interface UpdatePrivateDnsNamespaceRequest {
|
|
2436
2595
|
/**
|
|
2437
|
-
* <p>The ID of the
|
|
2438
|
-
* update.</p>
|
|
2596
|
+
* <p>The ID of the
|
|
2597
|
+
* namespace that you want to update.</p>
|
|
2439
2598
|
*/
|
|
2440
2599
|
Id: string | undefined;
|
|
2441
2600
|
/**
|
|
2442
|
-
* <p>A unique string that
|
|
2443
|
-
* request and that allows failed <code>UpdatePrivateDnsNamespace</code> requests to
|
|
2444
|
-
* running the operation twice. <code>UpdaterRequestId</code> can be
|
|
2445
|
-
* date/timestamp).</p>
|
|
2601
|
+
* <p>A unique string that
|
|
2602
|
+
* identifies the request and that allows failed <code>UpdatePrivateDnsNamespace</code> requests to
|
|
2603
|
+
* be retried without the risk of running the operation twice. <code>UpdaterRequestId</code> can be
|
|
2604
|
+
* any unique string (for example, a date/timestamp).</p>
|
|
2446
2605
|
*/
|
|
2447
2606
|
UpdaterRequestId?: string;
|
|
2448
2607
|
/**
|
|
2449
|
-
* <p>Updated properties
|
|
2450
|
-
* namespace.</p>
|
|
2608
|
+
* <p>Updated properties
|
|
2609
|
+
* for the private DNS namespace.</p>
|
|
2451
2610
|
*/
|
|
2452
2611
|
Namespace: PrivateDnsNamespaceChange | undefined;
|
|
2453
2612
|
}
|
|
@@ -2460,20 +2619,20 @@ export interface UpdatePrivateDnsNamespaceResponse {
|
|
|
2460
2619
|
}
|
|
2461
2620
|
export interface UpdatePublicDnsNamespaceRequest {
|
|
2462
2621
|
/**
|
|
2463
|
-
* <p>The ID of the
|
|
2464
|
-
* updated.</p>
|
|
2622
|
+
* <p>The ID of the
|
|
2623
|
+
* namespace being updated.</p>
|
|
2465
2624
|
*/
|
|
2466
2625
|
Id: string | undefined;
|
|
2467
2626
|
/**
|
|
2468
|
-
* <p>A unique string that
|
|
2469
|
-
* request and that allows failed <code>UpdatePublicDnsNamespace</code> requests to
|
|
2470
|
-
* running the operation twice. <code>UpdaterRequestId</code> can be
|
|
2471
|
-
* date/timestamp).</p>
|
|
2627
|
+
* <p>A unique string that
|
|
2628
|
+
* identifies the request and that allows failed <code>UpdatePublicDnsNamespace</code> requests to
|
|
2629
|
+
* be retried without the risk of running the operation twice. <code>UpdaterRequestId</code> can be
|
|
2630
|
+
* any unique string (for example, a date/timestamp).</p>
|
|
2472
2631
|
*/
|
|
2473
2632
|
UpdaterRequestId?: string;
|
|
2474
2633
|
/**
|
|
2475
|
-
* <p>Updated properties
|
|
2476
|
-
* namespace.</p>
|
|
2634
|
+
* <p>Updated properties
|
|
2635
|
+
* for the public DNS namespace.</p>
|
|
2477
2636
|
*/
|
|
2478
2637
|
Namespace: PublicDnsNamespaceChange | undefined;
|
|
2479
2638
|
}
|
|
@@ -2493,14 +2652,15 @@ export interface ServiceChange {
|
|
|
2493
2652
|
*/
|
|
2494
2653
|
Description?: string;
|
|
2495
2654
|
/**
|
|
2496
|
-
* <p>Information about the Route
|
|
2655
|
+
* <p>Information about the Route 53 DNS records that you want Cloud Map to create when you register
|
|
2656
|
+
* an instance.</p>
|
|
2497
2657
|
*/
|
|
2498
2658
|
DnsConfig?: DnsConfigChange;
|
|
2499
2659
|
/**
|
|
2500
2660
|
* <p>
|
|
2501
|
-
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
2502
|
-
* settings for a health check, Cloud Map associates the health check with
|
|
2503
|
-
*
|
|
2661
|
+
* <i>Public DNS and HTTP namespaces only.</i> Settings for an optional health
|
|
2662
|
+
* check. If you specify settings for a health check, Cloud Map associates the health check with
|
|
2663
|
+
* the records that you specify in <code>DnsConfig</code>.</p>
|
|
2504
2664
|
*/
|
|
2505
2665
|
HealthCheckConfig?: HealthCheckConfig;
|
|
2506
2666
|
}
|