Package software.amazon.awscdk.services.fsx

Interface CfnStorageVirtualMachineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStorageVirtualMachineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.258Z")
@Stability(Stable)
public interface CfnStorageVirtualMachineProps
extends software.amazon.jsii.JsiiSerializable

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 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"))
                         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStorageVirtualMachineProps.Builder	A builder for CfnStorageVirtualMachineProps
static final class	CfnStorageVirtualMachineProps.Jsii$Proxy	An implementation for CfnStorageVirtualMachineProps

Method Summary

Modifier and Type	Method	Description
static CfnStorageVirtualMachineProps.Builder	builder()
default Object	getActiveDirectoryConfiguration()	Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.
String	getFileSystemId()	Specifies the FSx for ONTAP file system on which to create the SVM.
String	getName()	The name of the SVM.
default String	getRootVolumeSecurityStyle()	The security style of the root volume of the SVM.
default String	getSvmAdminPassword()	Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.
default List<CfnTag>	getTags()	A list of Tag values, with a maximum of 50 elements.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFileSystemId

@Stability(Stable)
@NotNull
String getFileSystemId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-filesystemid

getName

@Stability(Stable)
@NotNull
String getName()

The name of the SVM.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-name

getActiveDirectoryConfiguration

@Stability(Stable)
@Nullable
default Object getActiveDirectoryConfiguration()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-activedirectoryconfiguration

getRootVolumeSecurityStyle

@Stability(Stable)
@Nullable
default String getRootVolumeSecurityStyle()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-rootvolumesecuritystyle

getSvmAdminPassword

@Stability(Stable)
@Nullable
default String getSvmAdminPassword()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-svmadminpassword

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-storagevirtualmachine.html#cfn-fsx-storagevirtualmachine-tags

builder

@Stability(Stable)
static CfnStorageVirtualMachineProps.Builder builder()

Returns:

a CfnStorageVirtualMachineProps.Builder of CfnStorageVirtualMachineProps