Skip to content
v2.278.0

CfnStorageVirtualMachineProps Struct ​

Properties for defining a CfnStorageVirtualMachine.

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 cfnStorageVirtualMachineProps: fsx.CfnStorageVirtualMachineProps = {
  fileSystemId: 'fileSystemId',
  name: 'name',

  // the properties below are optional
  activeDirectoryConfiguration: {
    netBiosName: 'netBiosName',
    selfManagedActiveDirectoryConfiguration: {
      dnsIps: ['dnsIps'],
      domainJoinServiceAccountSecret: 'domainJoinServiceAccountSecret',
      domainName: 'domainName',
      fileSystemAdministratorsGroup: 'fileSystemAdministratorsGroup',
      organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
      password: 'password',
      userName: 'userName',
    },
  },
  rootVolumeSecurityStyle: 'rootVolumeSecurityStyle',
  svmAdminPassword: 'svmAdminPassword',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# 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

cfn_storage_virtual_machine_props = fsx.CfnStorageVirtualMachineProps(
    file_system_id="fileSystemId",
    name="name",

    # the properties below are optional
    active_directory_configuration=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"
        )
    ),
    root_volume_security_style="rootVolumeSecurityStyle",
    svm_admin_password="svmAdminPassword",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
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.*;

CfnStorageVirtualMachineProps cfnStorageVirtualMachineProps = CfnStorageVirtualMachineProps.builder()
        .fileSystemId("fileSystemId")
        .name("name")

        // the properties below are optional
        .activeDirectoryConfiguration(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())
        .rootVolumeSecurityStyle("rootVolumeSecurityStyle")
        .svmAdminPassword("svmAdminPassword")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .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 cfnStorageVirtualMachineProps = new CfnStorageVirtualMachineProps {
    FileSystemId = "fileSystemId",
    Name = "name",

    // the properties below are optional
    ActiveDirectoryConfiguration = new ActiveDirectoryConfigurationProperty {
        NetBiosName = "netBiosName",
        SelfManagedActiveDirectoryConfiguration = new SelfManagedActiveDirectoryConfigurationProperty {
            DnsIps = new [] { "dnsIps" },
            DomainJoinServiceAccountSecret = "domainJoinServiceAccountSecret",
            DomainName = "domainName",
            FileSystemAdministratorsGroup = "fileSystemAdministratorsGroup",
            OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName",
            Password = "password",
            UserName = "userName"
        }
    },
    RootVolumeSecurityStyle = "rootVolumeSecurityStyle",
    SvmAdminPassword = "svmAdminPassword",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
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"

cfnStorageVirtualMachineProps := &CfnStorageVirtualMachineProps{
	FileSystemId: jsii.String("fileSystemId"),
	Name: jsii.String("name"),

	// the properties below are optional
	ActiveDirectoryConfiguration: &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"),
		},
	},
	RootVolumeSecurityStyle: jsii.String("rootVolumeSecurityStyle"),
	SvmAdminPassword: jsii.String("svmAdminPassword"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

activeDirectoryConfigurationoptionalIResolvable | CfnStorageVirtualMachine.ActiveDirectoryConfigurationPropertyactive_directory_configurationoptionaltyping.Union[IResolvable, ActiveDirectoryConfigurationProperty]activeDirectoryConfigurationoptionalIResolvableActiveDirectoryConfigurationoptionalIResolvableActiveDirectoryConfigurationoptionalinterface{} #
Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
fileSystemIdstringfile_system_idstrfileSystemIdStringFileSystemIdstringFileSystemId*string required #
Specifies the FSx for ONTAP file system on which to create the SVM.
namestringnamestrnameStringNamestringName*string required #
The name of the SVM.
rootVolumeSecurityStyleoptionalstringroot_volume_security_styleoptionalstrrootVolumeSecurityStyleoptionalStringRootVolumeSecurityStyleoptionalstringRootVolumeSecurityStyleoptional*string #
The security style of the root volume of the SVM. Specify one of the following values:.
notes
  • UNIX if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account.
  • NTFS if the file system is managed by a Microsoft Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Microsoft Windows user as the service account.
  • MIXED This is an advanced setting. For more information, see Volume security style in the Amazon FSx for NetApp ONTAP User Guide.
svmAdminPasswordoptionalstringsvm_admin_passwordoptionalstrsvmAdminPasswordoptionalStringSvmAdminPasswordoptionalstringSvmAdminPasswordoptional*string #
Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.
notes

Doing so enables you to manage the SVM using the NetApp ONTAP CLI or REST API. If you do not specify a password, you can still use the file system's fsxadmin user to manage the SVM. For more information, see Managing SVMs using the NetApp ONTAP CLI in the FSx for ONTAP User Guide .

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
A list of `Tag` values, with a maximum of 50 elements.