/AWS1/CL_DSYFSXPROTOCOLSMB

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see Providing DataSync access to FSx for ONTAP file systems.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_user TYPE /AWS1/DSYSMBUSER /AWS1/DSYSMBUSER

Specifies a user that can mount and access the files, folders, and metadata in your SVM.

For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

Optional arguments:

iv_domain TYPE /AWS1/DSYSMBDOMAIN /AWS1/DSYSMBDOMAIN

Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

io_mountoptions TYPE REF TO /AWS1/CL_DSYSMBMOUNTOPTIONS /AWS1/CL_DSYSMBMOUNTOPTIONS

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

iv_password TYPE /AWS1/DSYSMBPASSWORD /AWS1/DSYSMBPASSWORD

Specifies the password of a user who has permission to access your SVM.

io_managedsecretconfig TYPE REF TO /AWS1/CL_DSYMANAGEDSECRETCFG /AWS1/CL_DSYMANAGEDSECRETCFG

Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

Do not provide this for a CreateLocation request. ManagedSecretConfig is a ReadOnly property and is only be populated in the DescribeLocation response.

io_cmksecretconfig TYPE REF TO /AWS1/CL_DSYCMKSECRETCONFIG /AWS1/CL_DSYCMKSECRETCONFIG

Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx for ONTAP storage location (using SMB), with a customer-managed KMS key.

When you include this parameter as part of a CreateLocationFsxOntap request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

io_customsecretconfig TYPE REF TO /AWS1/CL_DSYCUSTOMSECRETCONFIG /AWS1/CL_DSYCUSTOMSECRETCONFIG

Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for ONTAP storage location (using SMB) is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

---

Queryable Attributes

Domain

Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

Accessible with the following methods

Method	Description
GET_DOMAIN()	Getter for DOMAIN, with configurable default
ASK_DOMAIN()	Getter for DOMAIN w/ exceptions if field has no value
HAS_DOMAIN()	Determine if DOMAIN has a value

MountOptions

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

Accessible with the following methods

Method	Description
GET_MOUNTOPTIONS()	Getter for MOUNTOPTIONS

Password

Specifies the password of a user who has permission to access your SVM.

Accessible with the following methods

Method	Description
GET_PASSWORD()	Getter for PASSWORD, with configurable default
ASK_PASSWORD()	Getter for PASSWORD w/ exceptions if field has no value
HAS_PASSWORD()	Determine if PASSWORD has a value

User

Specifies a user that can mount and access the files, folders, and metadata in your SVM.

For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

Accessible with the following methods

Method	Description
GET_USER()	Getter for USER, with configurable default
ASK_USER()	Getter for USER w/ exceptions if field has no value
HAS_USER()	Determine if USER has a value

ManagedSecretConfig

Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

Do not provide this for a CreateLocation request. ManagedSecretConfig is a ReadOnly property and is only be populated in the DescribeLocation response.

Accessible with the following methods

Method	Description
GET_MANAGEDSECRETCONFIG()	Getter for MANAGEDSECRETCONFIG

CmkSecretConfig

Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx for ONTAP storage location (using SMB), with a customer-managed KMS key.

When you include this parameter as part of a CreateLocationFsxOntap request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

Accessible with the following methods

Method	Description
GET_CMKSECRETCONFIG()	Getter for CMKSECRETCONFIG

CustomSecretConfig

Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for ONTAP storage location (using SMB) is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

Accessible with the following methods

Method	Description
GET_CUSTOMSECRETCONFIG()	Getter for CUSTOMSECRETCONFIG