Skip to content
v2.278.0

ActiveDirectoryConfigurationProperty Struct ​

Describes the self-managed Microsoft Active Directory to which you want to join the SVM.

Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS clients accessing the file system.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const activeDirectoryConfigurationProperty: fsx.CfnStorageVirtualMachine.ActiveDirectoryConfigurationProperty = {
  netBiosName: 'netBiosName',
  selfManagedActiveDirectoryConfiguration: {
    dnsIps: ['dnsIps'],
    domainJoinServiceAccountSecret: 'domainJoinServiceAccountSecret',
    domainName: 'domainName',
    fileSystemAdministratorsGroup: 'fileSystemAdministratorsGroup',
    organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
    password: 'password',
    userName: 'userName',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_fsx as fsx

active_directory_configuration_property = fsx.CfnStorageVirtualMachine.ActiveDirectoryConfigurationProperty(
    net_bios_name="netBiosName",
    self_managed_active_directory_configuration=fsx.CfnStorageVirtualMachine.SelfManagedActiveDirectoryConfigurationProperty(
        dns_ips=["dnsIps"],
        domain_join_service_account_secret="domainJoinServiceAccountSecret",
        domain_name="domainName",
        file_system_administrators_group="fileSystemAdministratorsGroup",
        organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
        password="password",
        user_name="userName"
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.fsx.*;

ActiveDirectoryConfigurationProperty activeDirectoryConfigurationProperty = ActiveDirectoryConfigurationProperty.builder()
        .netBiosName("netBiosName")
        .selfManagedActiveDirectoryConfiguration(SelfManagedActiveDirectoryConfigurationProperty.builder()
                .dnsIps(List.of("dnsIps"))
                .domainJoinServiceAccountSecret("domainJoinServiceAccountSecret")
                .domainName("domainName")
                .fileSystemAdministratorsGroup("fileSystemAdministratorsGroup")
                .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName")
                .password("password")
                .userName("userName")
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FSx;

var activeDirectoryConfigurationProperty = new ActiveDirectoryConfigurationProperty {
    NetBiosName = "netBiosName",
    SelfManagedActiveDirectoryConfiguration = new SelfManagedActiveDirectoryConfigurationProperty {
        DnsIps = new [] { "dnsIps" },
        DomainJoinServiceAccountSecret = "domainJoinServiceAccountSecret",
        DomainName = "domainName",
        FileSystemAdministratorsGroup = "fileSystemAdministratorsGroup",
        OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName",
        Password = "password",
        UserName = "userName"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

activeDirectoryConfigurationProperty := &ActiveDirectoryConfigurationProperty{
	NetBiosName: jsii.String("netBiosName"),
	SelfManagedActiveDirectoryConfiguration: &SelfManagedActiveDirectoryConfigurationProperty{
		DnsIps: []*string{
			jsii.String("dnsIps"),
		},
		DomainJoinServiceAccountSecret: jsii.String("domainJoinServiceAccountSecret"),
		DomainName: jsii.String("domainName"),
		FileSystemAdministratorsGroup: jsii.String("fileSystemAdministratorsGroup"),
		OrganizationalUnitDistinguishedName: jsii.String("organizationalUnitDistinguishedName"),
		Password: jsii.String("password"),
		UserName: jsii.String("userName"),
	},
}

Properties ​

netBiosNameoptionalstringnet_bios_nameoptionalstrnetBiosNameoptionalStringNetBiosNameoptionalstringNetBiosNameoptional*string #
The NetBIOS name of the Active Directory computer object that will be created for your SVM.
selfManagedActiveDirectoryConfigurationoptionalIResolvable | CfnStorageVirtualMachine.SelfManagedActiveDirectoryConfigurationPropertyself_managed_active_directory_configurationoptionaltyping.Union[IResolvable, SelfManagedActiveDirectoryConfigurationProperty]selfManagedActiveDirectoryConfigurationoptionalIResolvableSelfManagedActiveDirectoryConfigurationoptionalIResolvableSelfManagedActiveDirectoryConfigurationoptionalinterface{} #
The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory directory.