AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the RegisterInstance operation.
Creates or updates one or more records and, optionally, creates a health check based
on the settings in a specified service. When you submit a RegisterInstance
request, the following occurs:
For each DNS record that you define in the service that's specified by ServiceId
,
a record is created or updated in the hosted zone that's associated with the corresponding
namespace.
If the service includes HealthCheckConfig
, a health check is created based
on the settings in the health check configuration.
The health check, if any, is associated with each of the new or updated records.
One RegisterInstance
request must complete before you can submit another request
and specify the same service ID and instance ID.
For more information, see CreateService.
When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
If the health check is healthy: returns all the records
If the health check is unhealthy: returns the applicable value for the last healthy instance
If you didn't specify a health check configuration: returns all the records
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
Namespace: Amazon.ServiceDiscovery.Model
Assembly: AWSSDK.ServiceDiscovery.dll
Version: 3.x.y.z
public class RegisterInstanceRequest : AmazonServiceDiscoveryRequest IAmazonWebServiceRequest
The RegisterInstanceRequest type exposes the following members
Name | Description | |
---|---|---|
RegisterInstanceRequest() |
Name | Type | Description | |
---|---|---|---|
Attributes | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Attributes.
A string map that contains the following information for the service that you specify
in
Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries. The following are the supported attribute keys.
|
|
CreatorRequestId | System.String |
Gets and sets the property CreatorRequestId.
A unique string that identifies the request and that allows failed |
|
InstanceId | System.String |
Gets and sets the property InstanceId. An identifier that you want to associate with the instance. Note the following:
Do not include sensitive information in |
|
ServiceId | System.String |
Gets and sets the property ServiceId. The ID of the service that you want to use for settings for the instance. |
Example: Register Instance
var client = new AmazonServiceDiscoveryClient(); var response = client.RegisterInstance(new RegisterInstanceRequest { Attributes = new Dictionary<string, string> { { "AWS_INSTANCE_IPV4", "172.2.1.3" }, { "AWS_INSTANCE_PORT", "808" } }, CreatorRequestId = "7a48a98a-72e6-4849-bfa7-1a458e030d7b", InstanceId = "myservice-53", ServiceId = "srv-p5zdwlg5uvvzjita" }); string operationId = response.OperationId;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5