Class: Aws::FSx::Types::SelfManagedActiveDirectoryConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass SelfManagedActiveDirectoryConfiguration data as a hash:

{
  domain_name: "ActiveDirectoryFullyQualifiedName", # required
  organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
  file_system_administrators_group: "FileSystemAdministratorsGroupName",
  user_name: "DirectoryUserName", # required
  password: "DirectoryPassword", # required
  dns_ips: ["IpAddress"], # required
}

The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory or Managing SVMs.

Constant Summary collapse

SENSITIVE =
[:password]

Instance Attribute Summary collapse

Instance Attribute Details

#dns_ipsArray<String>

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

Returns:

  • (Array<String>)


6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6675

class SelfManagedActiveDirectoryConfiguration < Struct.new(
  :domain_name,
  :organizational_unit_distinguished_name,
  :file_system_administrators_group,
  :user_name,
  :password,
  :dns_ips)
  SENSITIVE = [:password]
  include Aws::Structure
end

#domain_nameString

The fully qualified domain name of the self-managed AD directory, such as corp.example.com.

Returns:

  • (String)


6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6675

class SelfManagedActiveDirectoryConfiguration < Struct.new(
  :domain_name,
  :organizational_unit_distinguished_name,
  :file_system_administrators_group,
  :user_name,
  :password,
  :dns_ips)
  SENSITIVE = [:password]
  include Aws::Structure
end

#file_system_administrators_groupString

(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.

Returns:

  • (String)


6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6675

class SelfManagedActiveDirectoryConfiguration < Struct.new(
  :domain_name,
  :organizational_unit_distinguished_name,
  :file_system_administrators_group,
  :user_name,
  :password,
  :dns_ips)
  SENSITIVE = [:password]
  include Aws::Structure
end

#organizational_unit_distinguished_nameString

(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.

Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

Returns:

  • (String)


6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6675

class SelfManagedActiveDirectoryConfiguration < Struct.new(
  :domain_name,
  :organizational_unit_distinguished_name,
  :file_system_administrators_group,
  :user_name,
  :password,
  :dns_ips)
  SENSITIVE = [:password]
  include Aws::Structure
end

#passwordString

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

Returns:

  • (String)


6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6675

class SelfManagedActiveDirectoryConfiguration < Struct.new(
  :domain_name,
  :organizational_unit_distinguished_name,
  :file_system_administrators_group,
  :user_name,
  :password,
  :dns_ips)
  SENSITIVE = [:password]
  include Aws::Structure
end

#user_nameString

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.

Returns:

  • (String)


6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6675

class SelfManagedActiveDirectoryConfiguration < Struct.new(
  :domain_name,
  :organizational_unit_distinguished_name,
  :file_system_administrators_group,
  :user_name,
  :password,
  :dns_ips)
  SENSITIVE = [:password]
  include Aws::Structure
end