Skip to content

Update Hybrid Ad

directoryservice_update_hybrid_ad R Documentation

Updates the configuration of an existing hybrid directory

Description

Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings.

Updates are applied asynchronously. Use describe_hybrid_ad_update to monitor the progress of configuration changes.

The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410].

You must provide at least one update to UpdateHybridADRequest$HybridAdministratorAccountUpdate or UpdateHybridADRequest$SelfManagedInstancesSettings.

Usage

directoryservice_update_hybrid_ad(DirectoryId,
  HybridAdministratorAccountUpdate, SelfManagedInstancesSettings)

Arguments

DirectoryId

[required] The identifier of the hybrid directory to update.
HybridAdministratorAccountUpdate

We create a hybrid directory administrator account when we create a hybrid directory. Use HybridAdministratorAccountUpdate to recover the hybrid directory administrator account if you have deleted it.

To recover your hybrid directory administrator account, we need temporary access to a user in your self-managed AD with administrator permissions in the form of a secret from Amazon Web Services Secrets Manager. We use these credentials once during recovery and don't store them.

If your hybrid directory administrator account exists, then you don’t need to use HybridAdministratorAccountUpdate, even if you have updated your self-managed AD administrator user.
SelfManagedInstancesSettings

Updates to the self-managed AD configuration, including DNS server IP addresses and Amazon Web Services System Manager managed node identifiers.

Value

A list with the following syntax:

list(
  DirectoryId = "string",
  AssessmentId = "string"
)

Request syntax

svc$update_hybrid_ad(
  DirectoryId = "string",
  HybridAdministratorAccountUpdate = list(
    SecretArn = "string"
  ),
  SelfManagedInstancesSettings = list(
    CustomerDnsIps = list(
      "string"
    ),
    InstanceIds = list(
      "string"
    )
  )
)