@aws-sdk/client-servicediscovery 3.188.0 → 3.191.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 +19 -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 +5 -2
- package/dist-types/runtimeConfig.d.ts +5 -2
- package/dist-types/runtimeConfig.native.d.ts +5 -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 +9 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +9 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +9 -1
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +6 -1
- package/package.json +27 -26
- 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
|
@@ -28,42 +28,49 @@ import { UpdateServiceCommandInput, UpdateServiceCommandOutput } from "./command
|
|
|
28
28
|
import { ServiceDiscoveryClient } from "./ServiceDiscoveryClient";
|
|
29
29
|
/**
|
|
30
30
|
* <fullname>Cloud Map</fullname>
|
|
31
|
-
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
|
|
32
|
-
* applications run in. When an instance becomes available, you can call the Cloud Map
|
|
33
|
-
* with Cloud Map. For public or private DNS namespaces, Cloud Map
|
|
34
|
-
* health check. Clients that submit public or
|
|
35
|
-
* that contains up to
|
|
31
|
+
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
|
|
32
|
+
* microservice applications run in. When an instance becomes available, you can call the Cloud Map
|
|
33
|
+
* API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map
|
|
34
|
+
* automatically creates DNS records and an optional health check. Clients that submit public or
|
|
35
|
+
* private DNS queries, or HTTP requests, for the service receive an answer that contains up to
|
|
36
|
+
* eight healthy records. </p>
|
|
36
37
|
*/
|
|
37
38
|
export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
38
39
|
/**
|
|
39
|
-
* <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
40
|
+
* <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
|
|
41
|
+
* discovered using a <code>DiscoverInstances</code> request but can't be discovered using
|
|
42
|
+
* DNS.</p>
|
|
43
|
+
* <p>For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
43
44
|
* <i>Cloud Map Developer Guide</i>.</p>
|
|
44
45
|
*/
|
|
45
46
|
createHttpNamespace(args: CreateHttpNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<CreateHttpNamespaceCommandOutput>;
|
|
46
47
|
createHttpNamespace(args: CreateHttpNamespaceCommandInput, cb: (err: any, data?: CreateHttpNamespaceCommandOutput) => void): void;
|
|
47
48
|
createHttpNamespace(args: CreateHttpNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHttpNamespaceCommandOutput) => void): void;
|
|
48
49
|
/**
|
|
49
|
-
* <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
|
|
50
|
-
* defines your service naming scheme. For example, if you name your namespace
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
50
|
+
* <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
|
|
51
|
+
* VPC. The namespace defines your service naming scheme. For example, if you name your namespace
|
|
52
|
+
* <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
|
|
53
|
+
* the service is <code>backend.example.com</code>. Service instances that are registered using a
|
|
54
|
+
* private DNS namespace can be discovered using either a <code>DiscoverInstances</code> request or
|
|
55
|
+
* using DNS. For the current quota on the number of namespaces that you can create using the same
|
|
56
|
+
* Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
55
57
|
* <i>Cloud Map Developer Guide</i>.</p>
|
|
56
58
|
*/
|
|
57
59
|
createPrivateDnsNamespace(args: CreatePrivateDnsNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<CreatePrivateDnsNamespaceCommandOutput>;
|
|
58
60
|
createPrivateDnsNamespace(args: CreatePrivateDnsNamespaceCommandInput, cb: (err: any, data?: CreatePrivateDnsNamespaceCommandOutput) => void): void;
|
|
59
61
|
createPrivateDnsNamespace(args: CreatePrivateDnsNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePrivateDnsNamespaceCommandOutput) => void): void;
|
|
60
62
|
/**
|
|
61
|
-
* <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
|
|
62
|
-
* naming scheme. For example, if you name your namespace
|
|
63
|
-
* <code>
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
63
|
+
* <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
|
|
64
|
+
* defines your service naming scheme. For example, if you name your namespace
|
|
65
|
+
* <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
|
|
66
|
+
* the service is <code>backend.example.com</code>. You can discover instances that were registered
|
|
67
|
+
* with a public DNS namespace by using either a <code>DiscoverInstances</code> request or using
|
|
68
|
+
* DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
69
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
70
|
+
*
|
|
71
|
+
* <important>
|
|
72
|
+
* <p>The <code>CreatePublicDnsNamespace</code> API operation is not supported in the Amazon Web Services GovCloud (US) Regions.</p>
|
|
73
|
+
* </important>
|
|
67
74
|
*/
|
|
68
75
|
createPublicDnsNamespace(args: CreatePublicDnsNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<CreatePublicDnsNamespaceCommandOutput>;
|
|
69
76
|
createPublicDnsNamespace(args: CreatePublicDnsNamespaceCommandInput, cb: (err: any, data?: CreatePublicDnsNamespaceCommandOutput) => void): void;
|
|
@@ -72,7 +79,8 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
|
72
79
|
* <p>Creates a service. This action defines the configuration for the following entities:</p>
|
|
73
80
|
* <ul>
|
|
74
81
|
* <li>
|
|
75
|
-
* <p>For public and private DNS namespaces, one of the following combinations of DNS records in
|
|
82
|
+
* <p>For public and private DNS namespaces, one of the following combinations of DNS records in
|
|
83
|
+
* Amazon Route 53:</p>
|
|
76
84
|
* <ul>
|
|
77
85
|
* <li>
|
|
78
86
|
* <p>
|
|
@@ -105,40 +113,40 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
|
105
113
|
* <p>Optionally, a health check</p>
|
|
106
114
|
* </li>
|
|
107
115
|
* </ul>
|
|
108
|
-
* <p>After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and
|
|
109
|
-
* values in the configuration to create the specified entities.</p>
|
|
110
|
-
* <p>For the current quota on the number of instances that you can register using the same
|
|
111
|
-
* same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
|
|
112
|
-
*
|
|
116
|
+
* <p>After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and
|
|
117
|
+
* Cloud Map uses the values in the configuration to create the specified entities.</p>
|
|
118
|
+
* <p>For the current quota on the number of instances that you can register using the same
|
|
119
|
+
* namespace and using the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
120
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
113
121
|
*/
|
|
114
122
|
createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceCommandOutput>;
|
|
115
123
|
createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
|
|
116
124
|
createService(args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
|
|
117
125
|
/**
|
|
118
|
-
* <p>Deletes a namespace from the current account. If the namespace still contains one or more
|
|
119
|
-
* fails.</p>
|
|
126
|
+
* <p>Deletes a namespace from the current account. If the namespace still contains one or more
|
|
127
|
+
* services, the request fails.</p>
|
|
120
128
|
*/
|
|
121
129
|
deleteNamespace(args: DeleteNamespaceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteNamespaceCommandOutput>;
|
|
122
130
|
deleteNamespace(args: DeleteNamespaceCommandInput, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void;
|
|
123
131
|
deleteNamespace(args: DeleteNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNamespaceCommandOutput) => void): void;
|
|
124
132
|
/**
|
|
125
|
-
* <p>Deletes a specified service. If the service still contains one or more registered instances,
|
|
126
|
-
* fails.</p>
|
|
133
|
+
* <p>Deletes a specified service. If the service still contains one or more registered instances,
|
|
134
|
+
* the request fails.</p>
|
|
127
135
|
*/
|
|
128
136
|
deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServiceCommandOutput>;
|
|
129
137
|
deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void;
|
|
130
138
|
deleteService(args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void;
|
|
131
139
|
/**
|
|
132
|
-
* <p>Deletes the Amazon Route
|
|
133
|
-
* instance.</p>
|
|
140
|
+
* <p>Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the
|
|
141
|
+
* specified instance.</p>
|
|
134
142
|
*/
|
|
135
143
|
deregisterInstance(args: DeregisterInstanceCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterInstanceCommandOutput>;
|
|
136
144
|
deregisterInstance(args: DeregisterInstanceCommandInput, cb: (err: any, data?: DeregisterInstanceCommandOutput) => void): void;
|
|
137
145
|
deregisterInstance(args: DeregisterInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterInstanceCommandOutput) => void): void;
|
|
138
146
|
/**
|
|
139
|
-
* <p>Discovers registered instances for a specified namespace and service. You can use
|
|
140
|
-
*
|
|
141
|
-
* to discover instances.</p>
|
|
147
|
+
* <p>Discovers registered instances for a specified namespace and service. You can use
|
|
148
|
+
* <code>DiscoverInstances</code> to discover instances for any type of namespace. For public and
|
|
149
|
+
* private DNS namespaces, you can also use DNS queries to discover instances.</p>
|
|
142
150
|
*/
|
|
143
151
|
discoverInstances(args: DiscoverInstancesCommandInput, options?: __HttpHandlerOptions): Promise<DiscoverInstancesCommandOutput>;
|
|
144
152
|
discoverInstances(args: DiscoverInstancesCommandInput, cb: (err: any, data?: DiscoverInstancesCommandOutput) => void): void;
|
|
@@ -150,11 +158,12 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
|
150
158
|
getInstance(args: GetInstanceCommandInput, cb: (err: any, data?: GetInstanceCommandOutput) => void): void;
|
|
151
159
|
getInstance(args: GetInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceCommandOutput) => void): void;
|
|
152
160
|
/**
|
|
153
|
-
* <p>Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or
|
|
154
|
-
*
|
|
161
|
+
* <p>Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or
|
|
162
|
+
* <code>Unknown</code>) of one or more instances that are associated with a specified
|
|
163
|
+
* service.</p>
|
|
155
164
|
* <note>
|
|
156
|
-
* <p>There's a brief delay between when you register an instance and when the health status for
|
|
157
|
-
* available. </p>
|
|
165
|
+
* <p>There's a brief delay between when you register an instance and when the health status for
|
|
166
|
+
* the instance is available. </p>
|
|
158
167
|
* </note>
|
|
159
168
|
*/
|
|
160
169
|
getInstancesHealthStatus(args: GetInstancesHealthStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetInstancesHealthStatusCommandOutput>;
|
|
@@ -183,13 +192,14 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
|
183
192
|
getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void;
|
|
184
193
|
getService(args: GetServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceCommandOutput) => void): void;
|
|
185
194
|
/**
|
|
186
|
-
* <p>Lists summary information about the instances that you registered by using a specified
|
|
195
|
+
* <p>Lists summary information about the instances that you registered by using a specified
|
|
196
|
+
* service.</p>
|
|
187
197
|
*/
|
|
188
198
|
listInstances(args: ListInstancesCommandInput, options?: __HttpHandlerOptions): Promise<ListInstancesCommandOutput>;
|
|
189
199
|
listInstances(args: ListInstancesCommandInput, cb: (err: any, data?: ListInstancesCommandOutput) => void): void;
|
|
190
200
|
listInstances(args: ListInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInstancesCommandOutput) => void): void;
|
|
191
201
|
/**
|
|
192
|
-
* <p>Lists summary information about the namespaces that were created by the current account.</p>
|
|
202
|
+
* <p>Lists summary information about the namespaces that were created by the current Amazon Web Services account.</p>
|
|
193
203
|
*/
|
|
194
204
|
listNamespaces(args: ListNamespacesCommandInput, options?: __HttpHandlerOptions): Promise<ListNamespacesCommandOutput>;
|
|
195
205
|
listNamespaces(args: ListNamespacesCommandInput, cb: (err: any, data?: ListNamespacesCommandOutput) => void): void;
|
|
@@ -201,7 +211,8 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
|
201
211
|
listOperations(args: ListOperationsCommandInput, cb: (err: any, data?: ListOperationsCommandOutput) => void): void;
|
|
202
212
|
listOperations(args: ListOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListOperationsCommandOutput) => void): void;
|
|
203
213
|
/**
|
|
204
|
-
* <p>Lists summary information for all the services that are associated with one or more
|
|
214
|
+
* <p>Lists summary information for all the services that are associated with one or more
|
|
215
|
+
* specified namespaces.</p>
|
|
205
216
|
*/
|
|
206
217
|
listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise<ListServicesCommandOutput>;
|
|
207
218
|
listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
|
|
@@ -213,46 +224,50 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
|
213
224
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
214
225
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
215
226
|
/**
|
|
216
|
-
* <p>Creates or updates one or more records and, optionally, creates a health check based on the
|
|
217
|
-
* specified service. When you submit a <code>RegisterInstance</code> request, the
|
|
227
|
+
* <p>Creates or updates one or more records and, optionally, creates a health check based on the
|
|
228
|
+
* settings in a specified service. When you submit a <code>RegisterInstance</code> request, the
|
|
229
|
+
* following occurs:</p>
|
|
218
230
|
* <ul>
|
|
219
231
|
* <li>
|
|
220
|
-
* <p>For each DNS record that you define in the service that's specified by
|
|
221
|
-
*
|
|
232
|
+
* <p>For each DNS record that you define in the service that's specified by
|
|
233
|
+
* <code>ServiceId</code>, a record is created or updated in the hosted zone that's associated
|
|
234
|
+
* with the corresponding namespace.</p>
|
|
222
235
|
* </li>
|
|
223
236
|
* <li>
|
|
224
|
-
* <p>If the service includes <code>HealthCheckConfig</code>, a health check is created based on
|
|
225
|
-
* health check configuration.</p>
|
|
237
|
+
* <p>If the service includes <code>HealthCheckConfig</code>, a health check is created based on
|
|
238
|
+
* the settings in the health check configuration.</p>
|
|
226
239
|
* </li>
|
|
227
240
|
* <li>
|
|
228
241
|
* <p>The health check, if any, is associated with each of the new or updated records.</p>
|
|
229
242
|
* </li>
|
|
230
243
|
* </ul>
|
|
231
244
|
* <important>
|
|
232
|
-
* <p>One <code>RegisterInstance</code> request must complete before you can submit another
|
|
233
|
-
* same service ID and instance ID.</p>
|
|
245
|
+
* <p>One <code>RegisterInstance</code> request must complete before you can submit another
|
|
246
|
+
* request and specify the same service ID and instance ID.</p>
|
|
234
247
|
* </important>
|
|
235
248
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html">CreateService</a>.</p>
|
|
236
|
-
* <p>When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable
|
|
249
|
+
* <p>When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable
|
|
250
|
+
* value:</p>
|
|
237
251
|
* <ul>
|
|
238
252
|
* <li>
|
|
239
253
|
* <p>
|
|
240
|
-
* <b>If the health check is healthy</b>: returns all the
|
|
254
|
+
* <b>If the health check is healthy</b>: returns all the
|
|
255
|
+
* records</p>
|
|
241
256
|
* </li>
|
|
242
257
|
* <li>
|
|
243
258
|
* <p>
|
|
244
|
-
* <b>If the health check is unhealthy</b>: returns the applicable
|
|
245
|
-
* healthy instance</p>
|
|
259
|
+
* <b>If the health check is unhealthy</b>: returns the applicable
|
|
260
|
+
* value for the last healthy instance</p>
|
|
246
261
|
* </li>
|
|
247
262
|
* <li>
|
|
248
263
|
* <p>
|
|
249
|
-
* <b>If you didn't specify a health check configuration</b>:
|
|
250
|
-
* records</p>
|
|
264
|
+
* <b>If you didn't specify a health check configuration</b>:
|
|
265
|
+
* returns all the records</p>
|
|
251
266
|
* </li>
|
|
252
267
|
* </ul>
|
|
253
|
-
* <p>For the current quota on the number of instances that you can register using the same
|
|
254
|
-
* same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
|
|
255
|
-
*
|
|
268
|
+
* <p>For the current quota on the number of instances that you can register using the same
|
|
269
|
+
* namespace and using the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
270
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
256
271
|
*/
|
|
257
272
|
registerInstance(args: RegisterInstanceCommandInput, options?: __HttpHandlerOptions): Promise<RegisterInstanceCommandOutput>;
|
|
258
273
|
registerInstance(args: RegisterInstanceCommandInput, cb: (err: any, data?: RegisterInstanceCommandOutput) => void): void;
|
|
@@ -277,10 +292,12 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
|
277
292
|
updateHttpNamespace(args: UpdateHttpNamespaceCommandInput, cb: (err: any, data?: UpdateHttpNamespaceCommandOutput) => void): void;
|
|
278
293
|
updateHttpNamespace(args: UpdateHttpNamespaceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateHttpNamespaceCommandOutput) => void): void;
|
|
279
294
|
/**
|
|
280
|
-
* <p>Submits a request to change the health status of a custom health check to healthy or
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
295
|
+
* <p>Submits a request to change the health status of a custom health check to healthy or
|
|
296
|
+
* unhealthy.</p>
|
|
297
|
+
* <p>You can use <code>UpdateInstanceCustomHealthStatus</code> to change the status only for
|
|
298
|
+
* custom health checks, which you define using <code>HealthCheckCustomConfig</code> when you create
|
|
299
|
+
* a service. You can't use it to change the status for Route 53 health checks, which you define using
|
|
300
|
+
* <code>HealthCheckConfig</code>.</p>
|
|
284
301
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html">HealthCheckCustomConfig</a>.</p>
|
|
285
302
|
*/
|
|
286
303
|
updateInstanceCustomHealthStatus(args: UpdateInstanceCustomHealthStatusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateInstanceCustomHealthStatusCommandOutput>;
|
|
@@ -309,23 +326,25 @@ export declare class ServiceDiscovery extends ServiceDiscoveryClient {
|
|
|
309
326
|
* <li>
|
|
310
327
|
* <p>Add, update, or delete <code>HealthCheckConfig</code> for a specified service</p>
|
|
311
328
|
* <note>
|
|
312
|
-
* <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code>
|
|
329
|
+
* <p>You can't add, update, or delete a <code>HealthCheckCustomConfig</code>
|
|
330
|
+
* configuration.</p>
|
|
313
331
|
* </note>
|
|
314
332
|
* </li>
|
|
315
333
|
* </ul>
|
|
316
334
|
* <p>For public and private DNS namespaces, note the following:</p>
|
|
317
335
|
* <ul>
|
|
318
336
|
* <li>
|
|
319
|
-
* <p>If you omit any existing <code>DnsRecords</code> or <code>HealthCheckConfig</code>
|
|
320
|
-
*
|
|
337
|
+
* <p>If you omit any existing <code>DnsRecords</code> or <code>HealthCheckConfig</code>
|
|
338
|
+
* configurations from an <code>UpdateService</code> request, the configurations are deleted from
|
|
339
|
+
* the service.</p>
|
|
321
340
|
* </li>
|
|
322
341
|
* <li>
|
|
323
|
-
* <p>If you omit an existing <code>HealthCheckCustomConfig</code> configuration from an
|
|
324
|
-
*
|
|
342
|
+
* <p>If you omit an existing <code>HealthCheckCustomConfig</code> configuration from an
|
|
343
|
+
* <code>UpdateService</code> request, the configuration isn't deleted from the service.</p>
|
|
325
344
|
* </li>
|
|
326
345
|
* </ul>
|
|
327
|
-
* <p>When you update settings for a service, Cloud Map also updates the corresponding settings
|
|
328
|
-
* and health checks that were created by using the specified service.</p>
|
|
346
|
+
* <p>When you update settings for a service, Cloud Map also updates the corresponding settings
|
|
347
|
+
* in all the records and health checks that were created by using the specified service.</p>
|
|
329
348
|
*/
|
|
330
349
|
updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceCommandOutput>;
|
|
331
350
|
updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void;
|
|
@@ -1,11 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { RegionInputConfig, RegionResolvedConfig } from "@aws-sdk/config-resolver";
|
|
2
|
+
import { EndpointInputConfig, EndpointResolvedConfig } from "@aws-sdk/middleware-endpoint";
|
|
2
3
|
import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
|
|
3
4
|
import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry";
|
|
4
5
|
import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
|
|
5
6
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
7
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
8
|
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
|
-
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider,
|
|
9
|
+
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
10
|
import { CreateHttpNamespaceCommandInput, CreateHttpNamespaceCommandOutput } from "./commands/CreateHttpNamespaceCommand";
|
|
10
11
|
import { CreatePrivateDnsNamespaceCommandInput, CreatePrivateDnsNamespaceCommandOutput } from "./commands/CreatePrivateDnsNamespaceCommand";
|
|
11
12
|
import { CreatePublicDnsNamespaceCommandInput, CreatePublicDnsNamespaceCommandOutput } from "./commands/CreatePublicDnsNamespaceCommand";
|
|
@@ -32,6 +33,7 @@ import { UpdateInstanceCustomHealthStatusCommandInput, UpdateInstanceCustomHealt
|
|
|
32
33
|
import { UpdatePrivateDnsNamespaceCommandInput, UpdatePrivateDnsNamespaceCommandOutput } from "./commands/UpdatePrivateDnsNamespaceCommand";
|
|
33
34
|
import { UpdatePublicDnsNamespaceCommandInput, UpdatePublicDnsNamespaceCommandOutput } from "./commands/UpdatePublicDnsNamespaceCommand";
|
|
34
35
|
import { UpdateServiceCommandInput, UpdateServiceCommandOutput } from "./commands/UpdateServiceCommand";
|
|
36
|
+
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
35
37
|
export declare type ServiceInputTypes = CreateHttpNamespaceCommandInput | CreatePrivateDnsNamespaceCommandInput | CreatePublicDnsNamespaceCommandInput | CreateServiceCommandInput | DeleteNamespaceCommandInput | DeleteServiceCommandInput | DeregisterInstanceCommandInput | DiscoverInstancesCommandInput | GetInstanceCommandInput | GetInstancesHealthStatusCommandInput | GetNamespaceCommandInput | GetOperationCommandInput | GetServiceCommandInput | ListInstancesCommandInput | ListNamespacesCommandInput | ListOperationsCommandInput | ListServicesCommandInput | ListTagsForResourceCommandInput | RegisterInstanceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateHttpNamespaceCommandInput | UpdateInstanceCustomHealthStatusCommandInput | UpdatePrivateDnsNamespaceCommandInput | UpdatePublicDnsNamespaceCommandInput | UpdateServiceCommandInput;
|
|
36
38
|
export declare type ServiceOutputTypes = CreateHttpNamespaceCommandOutput | CreatePrivateDnsNamespaceCommandOutput | CreatePublicDnsNamespaceCommandOutput | CreateServiceCommandOutput | DeleteNamespaceCommandOutput | DeleteServiceCommandOutput | DeregisterInstanceCommandOutput | DiscoverInstancesCommandOutput | GetInstanceCommandOutput | GetInstancesHealthStatusCommandOutput | GetNamespaceCommandOutput | GetOperationCommandOutput | GetServiceCommandOutput | ListInstancesCommandOutput | ListNamespacesCommandOutput | ListOperationsCommandOutput | ListServicesCommandOutput | ListTagsForResourceCommandOutput | RegisterInstanceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateHttpNamespaceCommandOutput | UpdateInstanceCustomHealthStatusCommandOutput | UpdatePrivateDnsNamespaceCommandOutput | UpdatePublicDnsNamespaceCommandOutput | UpdateServiceCommandOutput;
|
|
37
39
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
@@ -124,11 +126,6 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
124
126
|
* @internal
|
|
125
127
|
*/
|
|
126
128
|
credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
|
|
127
|
-
/**
|
|
128
|
-
* Fetch related hostname, signing name or signing region with given region.
|
|
129
|
-
* @internal
|
|
130
|
-
*/
|
|
131
|
-
regionInfoProvider?: RegionInfoProvider;
|
|
132
129
|
/**
|
|
133
130
|
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
134
131
|
* @internal
|
|
@@ -139,13 +136,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
139
136
|
*/
|
|
140
137
|
defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
|
|
141
138
|
}
|
|
142
|
-
declare type ServiceDiscoveryClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig &
|
|
139
|
+
declare type ServiceDiscoveryClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
143
140
|
/**
|
|
144
141
|
* The configuration interface of ServiceDiscoveryClient class constructor that set the region, credentials and other options.
|
|
145
142
|
*/
|
|
146
143
|
export interface ServiceDiscoveryClientConfig extends ServiceDiscoveryClientConfigType {
|
|
147
144
|
}
|
|
148
|
-
declare type ServiceDiscoveryClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig &
|
|
145
|
+
declare type ServiceDiscoveryClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
149
146
|
/**
|
|
150
147
|
* The resolved configuration interface of ServiceDiscoveryClient class. This is resolved and normalized from the {@link ServiceDiscoveryClientConfig | constructor configuration interface}.
|
|
151
148
|
*/
|
|
@@ -153,11 +150,12 @@ export interface ServiceDiscoveryClientResolvedConfig extends ServiceDiscoveryCl
|
|
|
153
150
|
}
|
|
154
151
|
/**
|
|
155
152
|
* <fullname>Cloud Map</fullname>
|
|
156
|
-
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
|
|
157
|
-
* applications run in. When an instance becomes available, you can call the Cloud Map
|
|
158
|
-
* with Cloud Map. For public or private DNS namespaces, Cloud Map
|
|
159
|
-
* health check. Clients that submit public or
|
|
160
|
-
* that contains up to
|
|
153
|
+
* <p>With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your
|
|
154
|
+
* microservice applications run in. When an instance becomes available, you can call the Cloud Map
|
|
155
|
+
* API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map
|
|
156
|
+
* automatically creates DNS records and an optional health check. Clients that submit public or
|
|
157
|
+
* private DNS queries, or HTTP requests, for the service receive an answer that contains up to
|
|
158
|
+
* eight healthy records. </p>
|
|
161
159
|
*/
|
|
162
160
|
export declare class ServiceDiscoveryClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ServiceDiscoveryClientResolvedConfig> {
|
|
163
161
|
/**
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
1
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
4
|
import { CreateHttpNamespaceRequest, CreateHttpNamespaceResponse } from "../models/models_0";
|
|
@@ -7,10 +8,10 @@ export interface CreateHttpNamespaceCommandInput extends CreateHttpNamespaceRequ
|
|
|
7
8
|
export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceResponse, __MetadataBearer {
|
|
8
9
|
}
|
|
9
10
|
/**
|
|
10
|
-
* <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>Creates an HTTP namespace. Service instances registered using an HTTP namespace can be
|
|
12
|
+
* discovered using a <code>DiscoverInstances</code> request but can't be discovered using
|
|
13
|
+
* DNS.</p>
|
|
14
|
+
* <p>For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
14
15
|
* <i>Cloud Map Developer Guide</i>.</p>
|
|
15
16
|
* @example
|
|
16
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,6 +30,7 @@ export interface CreateHttpNamespaceCommandOutput extends CreateHttpNamespaceRes
|
|
|
29
30
|
*/
|
|
30
31
|
export declare class CreateHttpNamespaceCommand extends $Command<CreateHttpNamespaceCommandInput, CreateHttpNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
|
|
31
32
|
readonly input: CreateHttpNamespaceCommandInput;
|
|
33
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
32
34
|
constructor(input: CreateHttpNamespaceCommandInput);
|
|
33
35
|
/**
|
|
34
36
|
* @internal
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
1
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
4
|
import { CreatePrivateDnsNamespaceRequest, CreatePrivateDnsNamespaceResponse } from "../models/models_0";
|
|
@@ -7,12 +8,13 @@ export interface CreatePrivateDnsNamespaceCommandInput extends CreatePrivateDnsN
|
|
|
7
8
|
export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDnsNamespaceResponse, __MetadataBearer {
|
|
8
9
|
}
|
|
9
10
|
/**
|
|
10
|
-
* <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
|
|
11
|
-
* defines your service naming scheme. For example, if you name your namespace
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* <p>Creates a private namespace based on DNS, which is visible only inside a specified Amazon
|
|
12
|
+
* VPC. The namespace defines your service naming scheme. For example, if you name your namespace
|
|
13
|
+
* <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
|
|
14
|
+
* the service is <code>backend.example.com</code>. Service instances that are registered using a
|
|
15
|
+
* private DNS namespace can be discovered using either a <code>DiscoverInstances</code> request or
|
|
16
|
+
* using DNS. For the current quota on the number of namespaces that you can create using the same
|
|
17
|
+
* Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
16
18
|
* <i>Cloud Map Developer Guide</i>.</p>
|
|
17
19
|
* @example
|
|
18
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -31,6 +33,7 @@ export interface CreatePrivateDnsNamespaceCommandOutput extends CreatePrivateDns
|
|
|
31
33
|
*/
|
|
32
34
|
export declare class CreatePrivateDnsNamespaceCommand extends $Command<CreatePrivateDnsNamespaceCommandInput, CreatePrivateDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
|
|
33
35
|
readonly input: CreatePrivateDnsNamespaceCommandInput;
|
|
36
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
34
37
|
constructor(input: CreatePrivateDnsNamespaceCommandInput);
|
|
35
38
|
/**
|
|
36
39
|
* @internal
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
1
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
4
|
import { CreatePublicDnsNamespaceRequest, CreatePublicDnsNamespaceResponse } from "../models/models_0";
|
|
@@ -7,12 +8,17 @@ export interface CreatePublicDnsNamespaceCommandInput extends CreatePublicDnsNam
|
|
|
7
8
|
export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNamespaceResponse, __MetadataBearer {
|
|
8
9
|
}
|
|
9
10
|
/**
|
|
10
|
-
* <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
|
|
11
|
-
* naming scheme. For example, if you name your namespace
|
|
12
|
-
* <code>
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* <p>Creates a public namespace based on DNS, which is visible on the internet. The namespace
|
|
12
|
+
* defines your service naming scheme. For example, if you name your namespace
|
|
13
|
+
* <code>example.com</code> and name your service <code>backend</code>, the resulting DNS name for
|
|
14
|
+
* the service is <code>backend.example.com</code>. You can discover instances that were registered
|
|
15
|
+
* with a public DNS namespace by using either a <code>DiscoverInstances</code> request or using
|
|
16
|
+
* DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
17
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
18
|
+
*
|
|
19
|
+
* <important>
|
|
20
|
+
* <p>The <code>CreatePublicDnsNamespace</code> API operation is not supported in the Amazon Web Services GovCloud (US) Regions.</p>
|
|
21
|
+
* </important>
|
|
16
22
|
* @example
|
|
17
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
24
|
* ```javascript
|
|
@@ -30,6 +36,7 @@ export interface CreatePublicDnsNamespaceCommandOutput extends CreatePublicDnsNa
|
|
|
30
36
|
*/
|
|
31
37
|
export declare class CreatePublicDnsNamespaceCommand extends $Command<CreatePublicDnsNamespaceCommandInput, CreatePublicDnsNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
|
|
32
38
|
readonly input: CreatePublicDnsNamespaceCommandInput;
|
|
39
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
33
40
|
constructor(input: CreatePublicDnsNamespaceCommandInput);
|
|
34
41
|
/**
|
|
35
42
|
* @internal
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
1
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
4
|
import { CreateServiceRequest, CreateServiceResponse } from "../models/models_0";
|
|
@@ -10,7 +11,8 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
10
11
|
* <p>Creates a service. This action defines the configuration for the following entities:</p>
|
|
11
12
|
* <ul>
|
|
12
13
|
* <li>
|
|
13
|
-
* <p>For public and private DNS namespaces, one of the following combinations of DNS records in
|
|
14
|
+
* <p>For public and private DNS namespaces, one of the following combinations of DNS records in
|
|
15
|
+
* Amazon Route 53:</p>
|
|
14
16
|
* <ul>
|
|
15
17
|
* <li>
|
|
16
18
|
* <p>
|
|
@@ -43,11 +45,11 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
43
45
|
* <p>Optionally, a health check</p>
|
|
44
46
|
* </li>
|
|
45
47
|
* </ul>
|
|
46
|
-
* <p>After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and
|
|
47
|
-
* values in the configuration to create the specified entities.</p>
|
|
48
|
-
* <p>For the current quota on the number of instances that you can register using the same
|
|
49
|
-
* same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map
|
|
50
|
-
*
|
|
48
|
+
* <p>After you create the service, you can submit a <a href="https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html">RegisterInstance</a> request, and
|
|
49
|
+
* Cloud Map uses the values in the configuration to create the specified entities.</p>
|
|
50
|
+
* <p>For the current quota on the number of instances that you can register using the same
|
|
51
|
+
* namespace and using the same service, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html">Cloud Map quotas</a> in the
|
|
52
|
+
* <i>Cloud Map Developer Guide</i>.</p>
|
|
51
53
|
* @example
|
|
52
54
|
* Use a bare-bones client and the command you need to make an API call.
|
|
53
55
|
* ```javascript
|
|
@@ -65,6 +67,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
65
67
|
*/
|
|
66
68
|
export declare class CreateServiceCommand extends $Command<CreateServiceCommandInput, CreateServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
|
|
67
69
|
readonly input: CreateServiceCommandInput;
|
|
70
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
68
71
|
constructor(input: CreateServiceCommandInput);
|
|
69
72
|
/**
|
|
70
73
|
* @internal
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
1
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
4
|
import { DeleteNamespaceRequest, DeleteNamespaceResponse } from "../models/models_0";
|
|
@@ -7,8 +8,8 @@ export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {
|
|
|
7
8
|
export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, __MetadataBearer {
|
|
8
9
|
}
|
|
9
10
|
/**
|
|
10
|
-
* <p>Deletes a namespace from the current account. If the namespace still contains one or more
|
|
11
|
-
* fails.</p>
|
|
11
|
+
* <p>Deletes a namespace from the current account. If the namespace still contains one or more
|
|
12
|
+
* services, the request fails.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -26,6 +27,7 @@ export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, _
|
|
|
26
27
|
*/
|
|
27
28
|
export declare class DeleteNamespaceCommand extends $Command<DeleteNamespaceCommandInput, DeleteNamespaceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
|
|
28
29
|
readonly input: DeleteNamespaceCommandInput;
|
|
30
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
29
31
|
constructor(input: DeleteNamespaceCommandInput);
|
|
30
32
|
/**
|
|
31
33
|
* @internal
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
1
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
4
|
import { DeleteServiceRequest, DeleteServiceResponse } from "../models/models_0";
|
|
@@ -7,8 +8,8 @@ export interface DeleteServiceCommandInput extends DeleteServiceRequest {
|
|
|
7
8
|
export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __MetadataBearer {
|
|
8
9
|
}
|
|
9
10
|
/**
|
|
10
|
-
* <p>Deletes a specified service. If the service still contains one or more registered instances,
|
|
11
|
-
* fails.</p>
|
|
11
|
+
* <p>Deletes a specified service. If the service still contains one or more registered instances,
|
|
12
|
+
* the request fails.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -26,6 +27,7 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
|
|
|
26
27
|
*/
|
|
27
28
|
export declare class DeleteServiceCommand extends $Command<DeleteServiceCommandInput, DeleteServiceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
|
|
28
29
|
readonly input: DeleteServiceCommandInput;
|
|
30
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
29
31
|
constructor(input: DeleteServiceCommandInput);
|
|
30
32
|
/**
|
|
31
33
|
* @internal
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
1
2
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
4
|
import { DeregisterInstanceRequest, DeregisterInstanceResponse } from "../models/models_0";
|
|
@@ -7,8 +8,8 @@ export interface DeregisterInstanceCommandInput extends DeregisterInstanceReques
|
|
|
7
8
|
export interface DeregisterInstanceCommandOutput extends DeregisterInstanceResponse, __MetadataBearer {
|
|
8
9
|
}
|
|
9
10
|
/**
|
|
10
|
-
* <p>Deletes the Amazon Route
|
|
11
|
-
* instance.</p>
|
|
11
|
+
* <p>Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the
|
|
12
|
+
* specified instance.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -26,6 +27,7 @@ export interface DeregisterInstanceCommandOutput extends DeregisterInstanceRespo
|
|
|
26
27
|
*/
|
|
27
28
|
export declare class DeregisterInstanceCommand extends $Command<DeregisterInstanceCommandInput, DeregisterInstanceCommandOutput, ServiceDiscoveryClientResolvedConfig> {
|
|
28
29
|
readonly input: DeregisterInstanceCommandInput;
|
|
30
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
29
31
|
constructor(input: DeregisterInstanceCommandInput);
|
|
30
32
|
/**
|
|
31
33
|
* @internal
|