interface CfnStorageVirtualMachineProps

Language	Type name
.NET	`Amazon.CDK.AWS.FSx.CfnStorageVirtualMachineProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsfsx#CfnStorageVirtualMachineProps`
Java	`software.amazon.awscdk.services.fsx.CfnStorageVirtualMachineProps`
Python	`aws_cdk.aws_fsx.CfnStorageVirtualMachineProps`
TypeScript	`aws-cdk-lib` » `aws_fsx` » `CfnStorageVirtualMachineProps`

Properties for defining a CfnStorageVirtualMachine.

Example

// 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'],
      domainName: 'domainName',
      fileSystemAdministratorsGroup: 'fileSystemAdministratorsGroup',
      organizationalUnitDistinguishedName: 'organizationalUnitDistinguishedName',
      password: 'password',
      userName: 'userName',
    },
  },
  rootVolumeSecurityStyle: 'rootVolumeSecurityStyle',
  svmAdminPassword: 'svmAdminPassword',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
fileSystemId	`string`	Specifies the FSx for ONTAP file system on which to create the SVM.
name	`string`	The name of the SVM.
activeDirectoryConfiguration?	`IResolvable` `\|` `ActiveDirectoryConfigurationProperty`	Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
rootVolumeSecurityStyle?	`string`	The security style of the root volume of the SVM. Specify one of the following values:.
svmAdminPassword?	`string`	Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.
tags?	`CfnTag[]`	A list of `Tag` values, with a maximum of 50 elements.

fileSystemId

Type: string

Specifies the FSx for ONTAP file system on which to create the SVM.

name

Type: string

The name of the SVM.

activeDirectoryConfiguration?

Type: IResolvable | ActiveDirectoryConfigurationProperty (optional)

Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

rootVolumeSecurityStyle?

Type: string (optional)

The security style of the root volume of the SVM. Specify one of the following values:.

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.

svmAdminPassword?

Type: string (optional)

Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.

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 .

tags?

Type: CfnTag[] (optional)

A list of Tag values, with a maximum of 50 elements.