Package software.amazon.awscdk.services.fsx

Class CfnStorageVirtualMachine

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.fsx.CfnStorageVirtualMachine
All Implemented Interfaces:
IInspectable, IStorageVirtualMachineRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.254Z") @Stability(Stable) public class CfnStorageVirtualMachine extends CfnResource implements IInspectable, IStorageVirtualMachineRef, ITaggable
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

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.*;
 CfnStorageVirtualMachine cfnStorageVirtualMachine = CfnStorageVirtualMachine.Builder.create(this, "MyCfnStorageVirtualMachine")
         .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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStorageVirtualMachine

      protected CfnStorageVirtualMachine(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStorageVirtualMachine

      protected CfnStorageVirtualMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStorageVirtualMachine

      @Stability(Stable) public CfnStorageVirtualMachine(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStorageVirtualMachineProps props)
      Create a new AWS::FSx::StorageVirtualMachine.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnStorageVirtualMachine

      @Stability(Stable) @NotNull public static Boolean isCfnStorageVirtualMachine(@NotNull Object x)
      Checks whether the given object is a CfnStorageVirtualMachine.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      Returns the storage virtual machine's Amazon Resource Name (ARN).

      Example: arn:aws:fsx:us-east-2:111111111111:storage-virtual-machine/fs-0123456789abcdef1/svm-01234567890123456

    • getAttrStorageVirtualMachineId

      @Stability(Stable) @NotNull public String getAttrStorageVirtualMachineId()
      Returns the storgage virtual machine's system generated ID.

      Example: svm-0123456789abcedf1

    • getAttrUuid

      @Stability(Stable) @NotNull public String getAttrUuid()
      Returns the storage virtual machine's system generated unique identifier (UUID).

      Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStorageVirtualMachineRef

      @Stability(Stable) @NotNull public StorageVirtualMachineReference getStorageVirtualMachineRef()
      A reference to a StorageVirtualMachine resource.
      Specified by:
      getStorageVirtualMachineRef in interface IStorageVirtualMachineRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getFileSystemId

      @Stability(Stable) @NotNull public String getFileSystemId()
      Specifies the FSx for ONTAP file system on which to create the SVM.

    • setFileSystemId

      @Stability(Stable) public void setFileSystemId(@NotNull String value)
      Specifies the FSx for ONTAP file system on which to create the SVM.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the SVM.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the SVM.

    • getActiveDirectoryConfiguration

      @Stability(Stable) @Nullable public Object getActiveDirectoryConfiguration()
      Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

      Returns union: either IResolvable or CfnStorageVirtualMachine.ActiveDirectoryConfigurationProperty

    • setActiveDirectoryConfiguration

      @Stability(Stable) public void setActiveDirectoryConfiguration(@Nullable IResolvable value)
      Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

    • setActiveDirectoryConfiguration

      @Stability(Stable) public void setActiveDirectoryConfiguration(@Nullable CfnStorageVirtualMachine.ActiveDirectoryConfigurationProperty value)
      Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

    • getRootVolumeSecurityStyle

      @Stability(Stable) @Nullable public String getRootVolumeSecurityStyle()
      The security style of the root volume of the SVM.

      Specify one of the following values:.

    • setRootVolumeSecurityStyle

      @Stability(Stable) public void setRootVolumeSecurityStyle(@Nullable String value)
      The security style of the root volume of the SVM.

      Specify one of the following values:.

    • getSvmAdminPassword

      @Stability(Stable) @Nullable public 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.

    • setSvmAdminPassword

      @Stability(Stable) public void setSvmAdminPassword(@Nullable String value)
      Specifies the password to use when logging on to the SVM using a secure shell (SSH) connection to the SVM's management endpoint.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of Tag values, with a maximum of 50 elements.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of Tag values, with a maximum of 50 elements.