Class OntapStorageVirtualMachine


  • public class OntapStorageVirtualMachine
    extends com.pulumi.resources.CustomResource
    Manages a FSx Storage Virtual Machine. See the [FSx ONTAP User Guide](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html) for more information. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.fsx.OntapStorageVirtualMachine;
     import com.pulumi.aws.fsx.OntapStorageVirtualMachineArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var test = new OntapStorageVirtualMachine("test", OntapStorageVirtualMachineArgs.builder()
                 .fileSystemId(testAwsFsxOntapFileSystem.id())
                 .name("test")
                 .build());
     
         }
     }
     
     
    ### Using a Self-Managed Microsoft Active Directory Additional information for using AWS Directory Service with ONTAP File Systems can be found in the [FSx ONTAP Guide](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/self-managed-AD.html).
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.fsx.OntapStorageVirtualMachine;
     import com.pulumi.aws.fsx.OntapStorageVirtualMachineArgs;
     import com.pulumi.aws.fsx.inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationArgs;
     import com.pulumi.aws.fsx.inputs.OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var test = new OntapStorageVirtualMachine("test", OntapStorageVirtualMachineArgs.builder()
                 .activeDirectoryConfiguration(OntapStorageVirtualMachineActiveDirectoryConfigurationArgs.builder()
                     .selfManagedActiveDirectoryConfiguration(OntapStorageVirtualMachineActiveDirectoryConfigurationSelfManagedActiveDirectoryConfigurationArgs.builder()
                         .dnsIps(                    
                             "10.0.0.111",
                             "10.0.0.222")
                         .domainName("corp.example.com")
                         .password("avoid-plaintext-passwords")
                         .username("Admin")
                         .build())
                     .netbiosName("mysvm")
                     .build())
                 .fileSystemId(testAwsFsxOntapFileSystem.id())
                 .name("mysvm")
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import FSx Storage Virtual Machine using the `id`. For example: ```sh $ pulumi import aws:fsx/ontapStorageVirtualMachine:OntapStorageVirtualMachine example svm-12345678abcdef123 ``` Certain resource arguments, like `svmAdminPassword` and the `selfManagedActiveDirectory` configuration block `password`, do not have a FSx API method for reading the information after creation. If these arguments are set in the Pulumi program on an imported resource, Pulumi will always show a difference. To workaround this behavior, either omit the argument from the Pulumi program or use `ignoreChanges` to hide the difference. For example:
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.fsx.OntapStorageVirtualMachine;
     import com.pulumi.aws.fsx.OntapStorageVirtualMachineArgs;
     import com.pulumi.resources.CustomResourceOptions;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new OntapStorageVirtualMachine("example", OntapStorageVirtualMachineArgs.builder()
                 .svmAdminPassword("avoid-plaintext-passwords")
                 .build(), CustomResourceOptions.builder()
                     .ignoreChanges("svmAdminPassword")
                     .build());
     
         }
     }
     
     
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<OntapStorageVirtualMachineActiveDirectoryConfiguration>> activeDirectoryConfiguration()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.List<OntapStorageVirtualMachineEndpoint>> endpoints()  
      com.pulumi.core.Output<java.lang.String> fileSystemId()  
      static OntapStorageVirtualMachine get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, OntapStorageVirtualMachineState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> rootVolumeSecurityStyle()  
      com.pulumi.core.Output<java.lang.String> subtype()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> svmAdminPassword()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> uuid()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OntapStorageVirtualMachine

        public OntapStorageVirtualMachine​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • OntapStorageVirtualMachine

        public OntapStorageVirtualMachine​(java.lang.String name,
                                          OntapStorageVirtualMachineArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • OntapStorageVirtualMachine

        public OntapStorageVirtualMachine​(java.lang.String name,
                                          OntapStorageVirtualMachineArgs args,
                                          @Nullable
                                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • activeDirectoryConfiguration

        public com.pulumi.core.Output<java.util.Optional<OntapStorageVirtualMachineActiveDirectoryConfiguration>> activeDirectoryConfiguration()
        Returns:
        Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below.
      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the storage virtual machine.
      • endpoints

        public com.pulumi.core.Output<java.util.List<OntapStorageVirtualMachineEndpoint>> endpoints()
        Returns:
        Endpoints that are used to access data or to manage the storage virtual machine using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. See `endpoints` below.
      • fileSystemId

        public com.pulumi.core.Output<java.lang.String> fileSystemId()
        Returns:
        ID of the Amazon FSx ONTAP File System that this SVM will be created on.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • rootVolumeSecurityStyle

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> rootVolumeSecurityStyle()
        Returns:
        Root volume security style. Valid values are `UNIX`, `NTFS`, and `MIXED`. All volumes created under this SVM will inherit the root security style unless the security style is specified on the volume. Default value is `UNIX`.
      • subtype

        public com.pulumi.core.Output<java.lang.String> subtype()
        Returns:
        SVM's subtype, e.g. `DEFAULT`
      • svmAdminPassword

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> svmAdminPassword()
        Returns:
        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.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the storage virtual machine. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • uuid

        public com.pulumi.core.Output<java.lang.String> uuid()
        Returns:
        SVM's UUID (universally unique identifier).
      • get

        public static OntapStorageVirtualMachine get​(java.lang.String name,
                                                     com.pulumi.core.Output<java.lang.String> id,
                                                     @Nullable
                                                     OntapStorageVirtualMachineState state,
                                                     @Nullable
                                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.