Class: Aws::FSx::Types::CreateStorageVirtualMachineRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass CreateStorageVirtualMachineRequest data as a hash:

{
  active_directory_configuration: {
    net_bios_name: "NetBiosAlias", # required
    self_managed_active_directory_configuration: {
      domain_name: "ActiveDirectoryFullyQualifiedName", # required
      organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
      file_system_administrators_group: "FileSystemAdministratorsGroupName",
      user_name: "DirectoryUserName", # required
      password: "DirectoryPassword", # required
      dns_ips: ["IpAddress"], # required
    },
  },
  client_request_token: "ClientRequestToken",
  file_system_id: "FileSystemId", # required
  name: "StorageVirtualMachineName", # required
  svm_admin_password: "AdminPassword",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  root_volume_security_style: "UNIX", # accepts UNIX, NTFS, MIXED
}

See Also:

Constant Summary collapse

SENSITIVE = 
[:svm_admin_password]

Instance Attribute Summary collapse

Instance Attribute Details

#active_directory_configuration ⇒ Types::CreateSvmActiveDirectoryConfiguration

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:



2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2814

class CreateStorageVirtualMachineRequest < Struct.new(
  :active_directory_configuration,
  :client_request_token,
  :file_system_id,
  :name,
  :svm_admin_password,
  :tags,
  :root_volume_security_style)
  SENSITIVE = [:svm_admin_password]
  include Aws::Structure
end

#client_request_token ⇒ String

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2814

class CreateStorageVirtualMachineRequest < Struct.new(
  :active_directory_configuration,
  :client_request_token,
  :file_system_id,
  :name,
  :svm_admin_password,
  :tags,
  :root_volume_security_style)
  SENSITIVE = [:svm_admin_password]
  include Aws::Structure
end

#file_system_id ⇒ String

The globally unique ID of the file system, assigned by Amazon FSx.

Returns:

  • (String) 


2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2814

class CreateStorageVirtualMachineRequest < Struct.new(
  :active_directory_configuration,
  :client_request_token,
  :file_system_id,
  :name,
  :svm_admin_password,
  :tags,
  :root_volume_security_style)
  SENSITIVE = [:svm_admin_password]
  include Aws::Structure
end

#name ⇒ String

The name of the SVM.

Returns:

  • (String) 


2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2814

class CreateStorageVirtualMachineRequest < Struct.new(
  :active_directory_configuration,
  :client_request_token,
  :file_system_id,
  :name,
  :svm_admin_password,
  :tags,
  :root_volume_security_style)
  SENSITIVE = [:svm_admin_password]
  include Aws::Structure
end

#root_volume_security_style ⇒ String

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.

Returns:

  • (String) 


2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2814

class CreateStorageVirtualMachineRequest < Struct.new(
  :active_directory_configuration,
  :client_request_token,
  :file_system_id,
  :name,
  :svm_admin_password,
  :tags,
  :root_volume_security_style)
  SENSITIVE = [:svm_admin_password]
  include Aws::Structure
end

#svm_admin_password ⇒ String

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:

  • (String) 


2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2814

class CreateStorageVirtualMachineRequest < Struct.new(
  :active_directory_configuration,
  :client_request_token,
  :file_system_id,
  :name,
  :svm_admin_password,
  :tags,
  :root_volume_security_style)
  SENSITIVE = [:svm_admin_password]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:



2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 2814

class CreateStorageVirtualMachineRequest < Struct.new(
  :active_directory_configuration,
  :client_request_token,
  :file_system_id,
  :name,
  :svm_admin_password,
  :tags,
  :root_volume_security_style)
  SENSITIVE = [:svm_admin_password]
  include Aws::Structure
end