<a id="cli-aws-servicediscovery-register-instance"></a>

# register-instance

## Description

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.

#### WARNING
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](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html) .

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](https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the *Cloud Map Developer Guide* .

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstance)

## Synopsis

```
  register-instance
--service-id <value>
--instance-id <value>
[--creator-request-id <value>]
--attributes <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--service-id` (string) [required]

> The ID or Amazon Resource Name (ARN) of the service that you want to use for settings for the instance. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see [Cross-account Cloud Map namespace sharing](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) in the *Cloud Map Developer Guide* .

> Constraints:

> * max: `255`

`--instance-id` (string) [required]

> An identifier that you want to associate with the instance. Note the following:

> * If the service that’s specified by `ServiceId` includes settings for an `SRV` record, the value of `InstanceId` is automatically included as part of the value for the `SRV` record. For more information, see [DnsRecord > Type](https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type) .
> * You can use this value to update an existing instance.
> * To register a new instance, you must specify a value that’s unique among instances that you register by using the same service.
> * If you specify an existing `InstanceId` and `ServiceId` , Cloud Map updates the existing DNS records, if any. If there’s also an existing health check, Cloud Map deletes the old health check and creates a new one.

> #### NOTE
> The health check isn’t deleted immediately, so it will still appear for a while if you submit a `ListHealthChecks` request, for example.

> #### NOTE
> Do not include sensitive information in `InstanceId` if the namespace is discoverable by public DNS queries and any `Type` member of `DnsRecord` for the service contains `SRV` because the `InstanceId` is discoverable by public DNS queries.

> Constraints:

> * max: `64`
> * pattern: `^[0-9a-zA-Z_/:.@-]+$`

`--creator-request-id` (string)

> A unique string that identifies the request and that allows failed `RegisterInstance` requests to be retried without the risk of executing the operation twice. You must use a unique `CreatorRequestId` string every time you submit a `RegisterInstance` request if you’re registering additional instances for the same namespace and service. `CreatorRequestId` can be any unique string (for example, a date/time stamp).

> Constraints:

> * max: `64`

`--attributes` (map) [required]

> A string map that contains the following information for the service that you specify in `ServiceId` :

> * The attributes that apply to the records that are defined in the service.
> * For each attribute, the applicable value.

> #### WARNING
> Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.

> The following are the supported attribute keys.

> > AWS_ALIAS_DNS_NAME

> If you want Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that’s associated with the load balancer. For information about how to get the DNS name, see “DNSName” in the topic [AliasTarget](https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html) in the *Route 53 API Reference* .

> Note the following:

> * The configuration for the service that’s specified by `ServiceId` must include settings for an `A` record, an `AAAA` record, or both.
> * In the service that’s specified by `ServiceId` , the value of `RoutingPolicy` must be `WEIGHTED` .
> * If the service that’s specified by `ServiceId` includes `HealthCheckConfig` settings, Cloud Map will create the Route 53 health check, but it doesn’t associate the health check with the alias record.
> * Cloud Map currently doesn’t support creating alias records that route traffic to Amazon Web Services resources other than Elastic Load Balancing load balancers.
> * If you specify a value for `AWS_ALIAS_DNS_NAME` , don’t specify values for any of the `AWS_INSTANCE` attributes.
> * The `AWS_ALIAS_DNS_NAME` is not supported in the GovCloud (US) Regions.

>   AWS_EC2_INSTANCE_ID

> > *HTTP namespaces only.* The Amazon EC2 instance ID for the instance. If the `AWS_EC2_INSTANCE_ID` attribute is specified, then the only other attribute that can be specified is `AWS_INIT_HEALTH_STATUS` . When the `AWS_EC2_INSTANCE_ID` attribute is specified, then the `AWS_INSTANCE_IPV4` attribute will be filled out with the primary private IPv4 address.

> > > AWS_INIT_HEALTH_STATUS

> If the service configuration includes `HealthCheckCustomConfig` , you can optionally use `AWS_INIT_HEALTH_STATUS` to specify the initial status of the custom health check, `HEALTHY` or `UNHEALTHY` . If you don’t specify a value for `AWS_INIT_HEALTH_STATUS` , the initial status is `HEALTHY` .

> > AWS_INSTANCE_CNAME

> If the service configuration includes a `CNAME` record, the domain name that you want Route 53 to return in response to DNS queries (for example, `example.com` ).

> This value is required if the service specified by `ServiceId` includes settings for an `CNAME` record.

> > AWS_INSTANCE_IPV4

> If the service configuration includes an `A` record, the IPv4 address that you want Route 53 to return in response to DNS queries (for example, `192.0.2.44` ).

> This value is required if the service specified by `ServiceId` includes settings for an `A` record. If the service includes settings for an `SRV` record, you must specify a value for `AWS_INSTANCE_IPV4` , `AWS_INSTANCE_IPV6` , or both.

> > AWS_INSTANCE_IPV6

> If the service configuration includes an `AAAA` record, the IPv6 address that you want Route 53 to return in response to DNS queries (for example, `2001:0db8:85a3:0000:0000:abcd:0001:2345` ).

> This value is required if the service specified by `ServiceId` includes settings for an `AAAA` record. If the service includes settings for an `SRV` record, you must specify a value for `AWS_INSTANCE_IPV4` , `AWS_INSTANCE_IPV6` , or both.

> > AWS_INSTANCE_PORT

> If the service includes an `SRV` record, the value that you want Route 53 to return for the port.

> If the service includes `HealthCheckConfig` , the port on the endpoint that you want Route 53 to send requests to.

> This value is required if you specified settings for an `SRV` record or a Route 53 health check when you created the service.

> > Custom attributes

> You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided attributes (sum of all keys and values) must not exceed 5,000 characters.

> > key -> (string)

> > Constraints:

> > * max: `255`
> > * pattern: `^[a-zA-Z0-9!-~]+$`

> value -> (string)

> > Constraints:

> > * max: `1024`
> > * pattern: `^([a-zA-Z0-9!-~][ \ta-zA-Z0-9!-~]*){0,1}[a-zA-Z0-9!-~]{0,1}$`

Shorthand Syntax:

```
KeyName1=string,KeyName2=string
```

JSON Syntax:

```json
{"string": "string"
  ...}
```

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**Example 1: To register a service instance using service ID**

The following `register-instance` example registers a service instance.

```bash
aws servicediscovery register-instance \
    --service-id srv-p5zdwlg5uvvzjita \
    --instance-id myservice-53 \
    --attributes=AWS_INSTANCE_IPV4=172.2.1.3,AWS_INSTANCE_PORT=808
```

Output:

```json
{
    "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7"
}
```

To confirm that the operation succeeded, you can run `get-operation`. For more information, see [get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html) .

For more information about registering an instance, see [Registering a resource as an AWS Cloud Map service instance](https://docs.aws.amazon.com/cloud-map/latest/dg/registering-instances.html) in the *AWS Cloud Map Developer Guide*.

**Example 2: To register a service instance using service ARN**

The following `register-instance` example registers a service instance using a service ARN. Specifying the ARN is required when registering instances in services that are shared with your account.

```bash
aws servicediscovery register-instance \
    --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \
    --instance-id web-server-01 \
    --attributes=AWS_INSTANCE_IPV4=203.0.113.15,AWS_INSTANCE_PORT=80
```

Output:

```json
{
    "OperationId": "gv4g5meo7ndmkqjrhpn39wk42xmpl"
}
```

For more information about cross-account namespace sharing, see [Shared AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html) in the *AWS Cloud Map Developer Guide*.

## Output

OperationId -> (string)

> A value that you can use to determine whether the request completed successfully. To get the status of the operation, see [GetOperation](https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html) .

> Constraints:

> * max: `255`