Use a custom value for OrganizationalUnitDistinguishedName when an FSx for Windows file system is recovered
arpio-config:fsx:ad:OrganizationalUnitDistinguishedName = <tag-safe-distinguished-name>
<tag-safe-distinguished-name>
The value to use for the OrganizationalUnitDistinguishedName property of the SelfManagedActiveDirectoryAttributes structure used to recover an FSx for Windows file system that uses a self-managed Active Directory, with colon characters used in place of comma characters.
FSx does not permit comma characters in tag values, so colon characters must be used in place of commas in the distinguished name value you specify.
If the value is empty, Arpio will not send a value for OrganizationalUnitDistinguishedName to AWS when recovering the file system, which causes FSx to use the default organizational unit.
Supported Resources
- FSx for Windows file systems (self-managed Active Directory only)
Description
When recovering an FSx for Windows file system with self-managed Active Directory settings, Arpio normally uses the OrganizationalUnitDistinguishedName value read from the primary environment. Sometimes you may need to use a different value in the recovery environment, for example, because the organizational unit that was originally used is no longer present in the directory, or should no longer be used for this purpose for some other reason.
You can use this config tag to specify a different value to use for OrganizationalUnitDistinguishedName when Arpio recovers the tagged filesystem. This tag only works for file systems configured to use a self-managed Active Directory. It will be ignored for other FSx file system types.
If you use an empty value for this tag, Arpio will send no value for the OrganizationalUnitDistinguishedName property when it recovers the filesystem. This causes the FSx service to use a default value.
Examples
| Tag | Value |
|---|---|
arpio-config:fsx:ad:OrganizationalUnitDistinguishedName |
OU=FSx:DC=storage:DC=example:DC=com |
arpio-config:fsx:ad:OrganizationalUnitDistinguishedName |
The first example tells Arpio to recover the filesystem using OU=FSx,DC=storage,DC=example,DC=com as the new organizational unit's distinguished name. Arpio converts colon characters in the tag value to comma characters before it sends the OU value to the FSx API during recovery.
The second example uses an empty tag value, which causes Arpio to send no value for the OrganizationalUnitDistinguishedName property when it recovers the filesystem. This causes the FSx service to use its default organizational unit.