amazonka-datasync-2.0: Amazon DataSync SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DataSync.CreateLocationFsxOntap

Description

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.

Synopsis

Creating a Request

data CreateLocationFsxOntap Source #

See: newCreateLocationFsxOntap smart constructor.

Constructors

CreateLocationFsxOntap' 

Fields

  • subdirectory :: Maybe Text

    Specifies the junction path (also known as a mount point) in the SVM volume where you're copying data to or from (for example, /vol1).

    Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

  • tags :: Maybe [TagListEntry]

    Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

  • protocol :: FsxProtocol
     
  • securityGroupArns :: NonEmpty Text

    Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.

    The security groups must allow outbound traffic on the following ports (depending on the protocol you use):

    • Network File System (NFS): TCP ports 111, 635, and 2049
    • Server Message Block (SMB): TCP port 445

    Your file system's security groups must also allow inbound traffic on the same ports.

  • storageVirtualMachineArn :: Text

    Specifies the ARN of the storage virtual machine (SVM) on your file system where you're copying data to or from.

Instances

Instances details
ToJSON CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

ToHeaders CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

ToPath CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

ToQuery CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

AWSRequest CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

Associated Types

type AWSResponse CreateLocationFsxOntap #

Generic CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

Associated Types

type Rep CreateLocationFsxOntap :: Type -> Type #

Show CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

NFData CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

Methods

rnf :: CreateLocationFsxOntap -> () #

Eq CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

Hashable CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

type AWSResponse CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

type Rep CreateLocationFsxOntap Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

type Rep CreateLocationFsxOntap = D1 ('MetaData "CreateLocationFsxOntap" "Amazonka.DataSync.CreateLocationFsxOntap" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationFsxOntap'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagListEntry]))) :*: (S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FsxProtocol) :*: (S1 ('MetaSel ('Just "securityGroupArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "storageVirtualMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateLocationFsxOntap Source #

Create a value of CreateLocationFsxOntap 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:subdirectory:CreateLocationFsxOntap', createLocationFsxOntap_subdirectory - Specifies the junction path (also known as a mount point) in the SVM volume where you're copying data to or from (for example, /vol1).

Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

$sel:tags:CreateLocationFsxOntap', createLocationFsxOntap_tags - Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

$sel:protocol:CreateLocationFsxOntap', createLocationFsxOntap_protocol - Undocumented member.

CreateLocationFsxOntap, createLocationFsxOntap_securityGroupArns - Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.

The security groups must allow outbound traffic on the following ports (depending on the protocol you use):

  • Network File System (NFS): TCP ports 111, 635, and 2049
  • Server Message Block (SMB): TCP port 445

Your file system's security groups must also allow inbound traffic on the same ports.

$sel:storageVirtualMachineArn:CreateLocationFsxOntap', createLocationFsxOntap_storageVirtualMachineArn - Specifies the ARN of the storage virtual machine (SVM) on your file system where you're copying data to or from.

Request Lenses

createLocationFsxOntap_subdirectory :: Lens' CreateLocationFsxOntap (Maybe Text) Source #

Specifies the junction path (also known as a mount point) in the SVM volume where you're copying data to or from (for example, /vol1).

Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

createLocationFsxOntap_tags :: Lens' CreateLocationFsxOntap (Maybe [TagListEntry]) Source #

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

createLocationFsxOntap_securityGroupArns :: Lens' CreateLocationFsxOntap (NonEmpty Text) Source #

Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.

The security groups must allow outbound traffic on the following ports (depending on the protocol you use):

  • Network File System (NFS): TCP ports 111, 635, and 2049
  • Server Message Block (SMB): TCP port 445

Your file system's security groups must also allow inbound traffic on the same ports.

createLocationFsxOntap_storageVirtualMachineArn :: Lens' CreateLocationFsxOntap Text Source #

Specifies the ARN of the storage virtual machine (SVM) on your file system where you're copying data to or from.

Destructuring the Response

data CreateLocationFsxOntapResponse Source #

See: newCreateLocationFsxOntapResponse smart constructor.

Constructors

CreateLocationFsxOntapResponse' 

Fields

Instances

Instances details
Generic CreateLocationFsxOntapResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

Associated Types

type Rep CreateLocationFsxOntapResponse :: Type -> Type #

Read CreateLocationFsxOntapResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

Show CreateLocationFsxOntapResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

NFData CreateLocationFsxOntapResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

Eq CreateLocationFsxOntapResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

type Rep CreateLocationFsxOntapResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationFsxOntap

type Rep CreateLocationFsxOntapResponse = D1 ('MetaData "CreateLocationFsxOntapResponse" "Amazonka.DataSync.CreateLocationFsxOntap" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationFsxOntapResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLocationFsxOntapResponse Source #

Create a value of CreateLocationFsxOntapResponse 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:

CreateLocationFsxOntapResponse, createLocationFsxOntapResponse_locationArn - Specifies the ARN of the FSx for ONTAP file system location that you create.

$sel:httpStatus:CreateLocationFsxOntapResponse', createLocationFsxOntapResponse_httpStatus - The response's http status code.

Response Lenses

createLocationFsxOntapResponse_locationArn :: Lens' CreateLocationFsxOntapResponse (Maybe Text) Source #

Specifies the ARN of the FSx for ONTAP file system location that you create.