Package software.amazon.awssdk.services.fsx.model

Class CreateStorageVirtualMachineRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.fsx.model.FSxRequest
software.amazon.awssdk.services.fsx.model.CreateStorageVirtualMachineRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateStorageVirtualMachineRequest.Builder,CreateStorageVirtualMachineRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateStorageVirtualMachineRequest extends FSxRequest implements ToCopyableBuilder<CreateStorageVirtualMachineRequest.Builder,CreateStorageVirtualMachineRequest>

  • Method Details

    • activeDirectoryConfiguration

      public final CreateSvmActiveDirectoryConfiguration activeDirectoryConfiguration()

      Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS client accessing the file system.

      Returns:
      Describes the self-managed Microsoft Active Directory to which you want to join the SVM. Joining an Active Directory provides user authentication and access control for SMB clients, including Microsoft Windows and macOS client accessing the file system.

    • clientRequestToken

      public final String clientRequestToken()
      Returns the value of the ClientRequestToken property for this object.
      Returns:
      The value of the ClientRequestToken property for this object.

    • fileSystemId

      public final String fileSystemId()
      Returns the value of the FileSystemId property for this object.
      Returns:
      The value of the FileSystemId property for this object.

    • name

      public final String name()

      The name of the SVM.

      Returns:
      The name of the SVM.

    • svmAdminPassword

      public final String svmAdminPassword()

      The password to use when managing 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.

      Returns:
      The password to use when managing 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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()
      Returns the value of the Tags property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The value of the Tags property for this object.

    • rootVolumeSecurityStyle

      public final StorageVirtualMachineRootVolumeSecurityStyle rootVolumeSecurityStyle()

      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 Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.

      • MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

      If the service returns an enum value that is not available in the current SDK version, rootVolumeSecurityStyle will return StorageVirtualMachineRootVolumeSecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootVolumeSecurityStyleAsString().

      Returns:
      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 Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.

      • MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

      See Also:

    • rootVolumeSecurityStyleAsString

      public final String rootVolumeSecurityStyleAsString()

      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 Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.

      • MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

      If the service returns an enum value that is not available in the current SDK version, rootVolumeSecurityStyle will return StorageVirtualMachineRootVolumeSecurityStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootVolumeSecurityStyleAsString().

      Returns:
      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 Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account.

      • MIXED if the file system is managed by both UNIX and Windows administrators and users consist of both NFS and SMB clients.

      See Also:

    • toBuilder

      public CreateStorageVirtualMachineRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateStorageVirtualMachineRequest.Builder,CreateStorageVirtualMachineRequest>
      Specified by:
      toBuilder in class FSxRequest
      Returns:
      a builder for type T

    • builder

      public static CreateStorageVirtualMachineRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateStorageVirtualMachineRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.