Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.CreateStorageVirtualMachine

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.

Synopsis

Creating a Request

data CreateStorageVirtualMachine Source #

See: newCreateStorageVirtualMachine smart constructor.

Constructors

CreateStorageVirtualMachine'

Fields

activeDirectoryConfiguration :: Maybe 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.
clientRequestToken :: Maybe Text
rootVolumeSecurityStyle :: Maybe StorageVirtualMachineRootVolumeSecurityStyle
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.
svmAdminPassword :: Maybe (Sensitive Text)
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.
tags :: Maybe (NonEmpty Tag)
fileSystemId :: Text
name :: Text
The name of the SVM.

Instances

Instances details

ToJSON CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods toJSON :: CreateStorageVirtualMachine -> Value # toEncoding :: CreateStorageVirtualMachine -> Encoding # toJSONList :: [CreateStorageVirtualMachine] -> Value # toEncodingList :: [CreateStorageVirtualMachine] -> Encoding #
ToHeaders CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods toHeaders :: CreateStorageVirtualMachine -> [Header] #
ToPath CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods toPath :: CreateStorageVirtualMachine -> ByteString #
ToQuery CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods toQuery :: CreateStorageVirtualMachine -> QueryString #
AWSRequest CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Associated Types type AWSResponse CreateStorageVirtualMachine # Methods request :: (Service -> Service) -> CreateStorageVirtualMachine -> Request CreateStorageVirtualMachine # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateStorageVirtualMachine -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStorageVirtualMachine))) #
Generic CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Associated Types type Rep CreateStorageVirtualMachine :: Type -> Type # Methods from :: CreateStorageVirtualMachine -> Rep CreateStorageVirtualMachine x # to :: Rep CreateStorageVirtualMachine x -> CreateStorageVirtualMachine #
Show CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods showsPrec :: Int -> CreateStorageVirtualMachine -> ShowS # show :: CreateStorageVirtualMachine -> String # showList :: [CreateStorageVirtualMachine] -> ShowS #
NFData CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods rnf :: CreateStorageVirtualMachine -> () #
Eq CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods (==) :: CreateStorageVirtualMachine -> CreateStorageVirtualMachine -> Bool # (/=) :: CreateStorageVirtualMachine -> CreateStorageVirtualMachine -> Bool #
Hashable CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods hashWithSalt :: Int -> CreateStorageVirtualMachine -> Int # hash :: CreateStorageVirtualMachine -> Int #
type AWSResponse CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine type AWSResponse CreateStorageVirtualMachine = CreateStorageVirtualMachineResponse
type Rep CreateStorageVirtualMachine Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine type Rep CreateStorageVirtualMachine = D1 ('MetaData "CreateStorageVirtualMachine" "Amazonka.FSx.CreateStorageVirtualMachine" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateStorageVirtualMachine'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "activeDirectoryConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateSvmActiveDirectoryConfiguration)) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "rootVolumeSecurityStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageVirtualMachineRootVolumeSecurityStyle)))) :: ((S1 ('MetaSel ('Just "svmAdminPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateStorageVirtualMachine Source #

Arguments

:: Text	`CreateStorageVirtualMachine`
-> Text	`CreateStorageVirtualMachine`
-> CreateStorageVirtualMachine

Create a value of CreateStorageVirtualMachine with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateStorageVirtualMachine, createStorageVirtualMachine_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.

$sel:clientRequestToken:CreateStorageVirtualMachine', createStorageVirtualMachine_clientRequestToken - Undocumented member.

CreateStorageVirtualMachine, createStorageVirtualMachine_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.

$sel:svmAdminPassword:CreateStorageVirtualMachine', createStorageVirtualMachine_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.

CreateStorageVirtualMachine, createStorageVirtualMachine_tags - Undocumented member.

CreateStorageVirtualMachine, createStorageVirtualMachine_fileSystemId - Undocumented member.

CreateStorageVirtualMachine, createStorageVirtualMachine_name - The name of the SVM.

Request Lenses

createStorageVirtualMachine_activeDirectoryConfiguration :: Lens' CreateStorageVirtualMachine (Maybe CreateSvmActiveDirectoryConfiguration) Source #

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.

createStorageVirtualMachine_clientRequestToken :: Lens' CreateStorageVirtualMachine (Maybe Text) Source #

Undocumented member.

createStorageVirtualMachine_rootVolumeSecurityStyle :: Lens' CreateStorageVirtualMachine (Maybe StorageVirtualMachineRootVolumeSecurityStyle) Source #

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.

createStorageVirtualMachine_svmAdminPassword :: Lens' CreateStorageVirtualMachine (Maybe Text) Source #

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.

createStorageVirtualMachine_tags :: Lens' CreateStorageVirtualMachine (Maybe (NonEmpty Tag)) Source #

Undocumented member.

createStorageVirtualMachine_fileSystemId :: Lens' CreateStorageVirtualMachine Text Source #

Undocumented member.

createStorageVirtualMachine_name :: Lens' CreateStorageVirtualMachine Text Source #

The name of the SVM.

Destructuring the Response

data CreateStorageVirtualMachineResponse Source #

See: newCreateStorageVirtualMachineResponse smart constructor.

Constructors

CreateStorageVirtualMachineResponse'
Fields storageVirtualMachine :: Maybe StorageVirtualMachine Returned after a successful `CreateStorageVirtualMachine` operation; describes the SVM just created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateStorageVirtualMachineResponse Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Associated Types type Rep CreateStorageVirtualMachineResponse :: Type -> Type # Methods from :: CreateStorageVirtualMachineResponse -> Rep CreateStorageVirtualMachineResponse x # to :: Rep CreateStorageVirtualMachineResponse x -> CreateStorageVirtualMachineResponse #
Read CreateStorageVirtualMachineResponse Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods readsPrec :: Int -> ReadS CreateStorageVirtualMachineResponse # readList :: ReadS [CreateStorageVirtualMachineResponse] # readPrec :: ReadPrec CreateStorageVirtualMachineResponse # readListPrec :: ReadPrec [CreateStorageVirtualMachineResponse] #
Show CreateStorageVirtualMachineResponse Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods showsPrec :: Int -> CreateStorageVirtualMachineResponse -> ShowS # show :: CreateStorageVirtualMachineResponse -> String # showList :: [CreateStorageVirtualMachineResponse] -> ShowS #
NFData CreateStorageVirtualMachineResponse Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods rnf :: CreateStorageVirtualMachineResponse -> () #
Eq CreateStorageVirtualMachineResponse Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine Methods (==) :: CreateStorageVirtualMachineResponse -> CreateStorageVirtualMachineResponse -> Bool # (/=) :: CreateStorageVirtualMachineResponse -> CreateStorageVirtualMachineResponse -> Bool #
type Rep CreateStorageVirtualMachineResponse Source #
Instance details Defined in Amazonka.FSx.CreateStorageVirtualMachine type Rep CreateStorageVirtualMachineResponse = D1 ('MetaData "CreateStorageVirtualMachineResponse" "Amazonka.FSx.CreateStorageVirtualMachine" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateStorageVirtualMachineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "storageVirtualMachine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageVirtualMachine)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateStorageVirtualMachineResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateStorageVirtualMachineResponse'`
-> CreateStorageVirtualMachineResponse

Create a value of CreateStorageVirtualMachineResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:storageVirtualMachine:CreateStorageVirtualMachineResponse', createStorageVirtualMachineResponse_storageVirtualMachine - Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.

$sel:httpStatus:CreateStorageVirtualMachineResponse', createStorageVirtualMachineResponse_httpStatus - The response's http status code.

Response Lenses

createStorageVirtualMachineResponse_storageVirtualMachine :: Lens' CreateStorageVirtualMachineResponse (Maybe StorageVirtualMachine) Source #

Returned after a successful CreateStorageVirtualMachine operation; describes the SVM just created.

createStorageVirtualMachineResponse_httpStatus :: Lens' CreateStorageVirtualMachineResponse Int Source #

The response's http status code.