AWS SDK for C++  1.9.130
AWS SDK for C++
Public Member Functions | List of all members
Aws::DataSync::Model::CreateLocationSmbRequest Class Reference

#include <CreateLocationSmbRequest.h>

+ Inheritance diagram for Aws::DataSync::Model::CreateLocationSmbRequest:

Public Member Functions

 CreateLocationSmbRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetSubdirectory () const
 
bool SubdirectoryHasBeenSet () const
 
void SetSubdirectory (const Aws::String &value)
 
void SetSubdirectory (Aws::String &&value)
 
void SetSubdirectory (const char *value)
 
CreateLocationSmbRequestWithSubdirectory (const Aws::String &value)
 
CreateLocationSmbRequestWithSubdirectory (Aws::String &&value)
 
CreateLocationSmbRequestWithSubdirectory (const char *value)
 
const Aws::StringGetServerHostname () const
 
bool ServerHostnameHasBeenSet () const
 
void SetServerHostname (const Aws::String &value)
 
void SetServerHostname (Aws::String &&value)
 
void SetServerHostname (const char *value)
 
CreateLocationSmbRequestWithServerHostname (const Aws::String &value)
 
CreateLocationSmbRequestWithServerHostname (Aws::String &&value)
 
CreateLocationSmbRequestWithServerHostname (const char *value)
 
const Aws::StringGetUser () const
 
bool UserHasBeenSet () const
 
void SetUser (const Aws::String &value)
 
void SetUser (Aws::String &&value)
 
void SetUser (const char *value)
 
CreateLocationSmbRequestWithUser (const Aws::String &value)
 
CreateLocationSmbRequestWithUser (Aws::String &&value)
 
CreateLocationSmbRequestWithUser (const char *value)
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
CreateLocationSmbRequestWithDomain (const Aws::String &value)
 
CreateLocationSmbRequestWithDomain (Aws::String &&value)
 
CreateLocationSmbRequestWithDomain (const char *value)
 
const Aws::StringGetPassword () const
 
bool PasswordHasBeenSet () const
 
void SetPassword (const Aws::String &value)
 
void SetPassword (Aws::String &&value)
 
void SetPassword (const char *value)
 
CreateLocationSmbRequestWithPassword (const Aws::String &value)
 
CreateLocationSmbRequestWithPassword (Aws::String &&value)
 
CreateLocationSmbRequestWithPassword (const char *value)
 
const Aws::Vector< Aws::String > & GetAgentArns () const
 
bool AgentArnsHasBeenSet () const
 
void SetAgentArns (const Aws::Vector< Aws::String > &value)
 
void SetAgentArns (Aws::Vector< Aws::String > &&value)
 
CreateLocationSmbRequestWithAgentArns (const Aws::Vector< Aws::String > &value)
 
CreateLocationSmbRequestWithAgentArns (Aws::Vector< Aws::String > &&value)
 
CreateLocationSmbRequestAddAgentArns (const Aws::String &value)
 
CreateLocationSmbRequestAddAgentArns (Aws::String &&value)
 
CreateLocationSmbRequestAddAgentArns (const char *value)
 
const SmbMountOptionsGetMountOptions () const
 
bool MountOptionsHasBeenSet () const
 
void SetMountOptions (const SmbMountOptions &value)
 
void SetMountOptions (SmbMountOptions &&value)
 
CreateLocationSmbRequestWithMountOptions (const SmbMountOptions &value)
 
CreateLocationSmbRequestWithMountOptions (SmbMountOptions &&value)
 
const Aws::Vector< TagListEntry > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< TagListEntry > &value)
 
void SetTags (Aws::Vector< TagListEntry > &&value)
 
CreateLocationSmbRequestWithTags (const Aws::Vector< TagListEntry > &value)
 
CreateLocationSmbRequestWithTags (Aws::Vector< TagListEntry > &&value)
 
CreateLocationSmbRequestAddTags (const TagListEntry &value)
 
CreateLocationSmbRequestAddTags (TagListEntry &&value)
 
- Public Member Functions inherited from Aws::DataSync::DataSyncRequest
virtual ~DataSyncRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

CreateLocationSmbRequest

See Also:

AWS API Reference

Definition at line 27 of file CreateLocationSmbRequest.h.

Constructor & Destructor Documentation

◆ CreateLocationSmbRequest()

Aws::DataSync::Model::CreateLocationSmbRequest::CreateLocationSmbRequest ( )

Member Function Documentation

◆ AddAgentArns() [1/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::AddAgentArns ( Aws::String &&  value)
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 462 of file CreateLocationSmbRequest.h.

◆ AddAgentArns() [2/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::AddAgentArns ( const Aws::String value)
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 456 of file CreateLocationSmbRequest.h.

◆ AddAgentArns() [3/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::AddAgentArns ( const char *  value)
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 468 of file CreateLocationSmbRequest.h.

◆ AddTags() [1/2]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::AddTags ( const TagListEntry value)
inline

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Definition at line 549 of file CreateLocationSmbRequest.h.

◆ AddTags() [2/2]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::AddTags ( TagListEntry &&  value)
inline

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Definition at line 556 of file CreateLocationSmbRequest.h.

◆ AgentArnsHasBeenSet()

bool Aws::DataSync::Model::CreateLocationSmbRequest::AgentArnsHasBeenSet ( ) const
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 426 of file CreateLocationSmbRequest.h.

◆ DomainHasBeenSet()

bool Aws::DataSync::Model::CreateLocationSmbRequest::DomainHasBeenSet ( ) const
inline

The name of the Windows domain that the SMB server belongs to.

Definition at line 334 of file CreateLocationSmbRequest.h.

◆ GetAgentArns()

const Aws::Vector<Aws::String>& Aws::DataSync::Model::CreateLocationSmbRequest::GetAgentArns ( ) const
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 420 of file CreateLocationSmbRequest.h.

◆ GetDomain()

const Aws::String& Aws::DataSync::Model::CreateLocationSmbRequest::GetDomain ( ) const
inline

The name of the Windows domain that the SMB server belongs to.

Definition at line 329 of file CreateLocationSmbRequest.h.

◆ GetMountOptions()

const SmbMountOptions& Aws::DataSync::Model::CreateLocationSmbRequest::GetMountOptions ( ) const
inline

The mount options used by DataSync to access the SMB server.

Definition at line 474 of file CreateLocationSmbRequest.h.

◆ GetPassword()

const Aws::String& Aws::DataSync::Model::CreateLocationSmbRequest::GetPassword ( ) const
inline

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Definition at line 371 of file CreateLocationSmbRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DataSync::Model::CreateLocationSmbRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::DataSync::DataSyncRequest.

◆ GetServerHostname()

const Aws::String& Aws::DataSync::Model::CreateLocationSmbRequest::GetServerHostname ( ) const
inline

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Definition at line 195 of file CreateLocationSmbRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DataSync::Model::CreateLocationSmbRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateLocationSmbRequest.h.

◆ GetSubdirectory()

const Aws::String& Aws::DataSync::Model::CreateLocationSmbRequest::GetSubdirectory ( ) const
inline

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Definition at line 59 of file CreateLocationSmbRequest.h.

◆ GetTags()

const Aws::Vector<TagListEntry>& Aws::DataSync::Model::CreateLocationSmbRequest::GetTags ( ) const
inline

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Definition at line 507 of file CreateLocationSmbRequest.h.

◆ GetUser()

const Aws::String& Aws::DataSync::Model::CreateLocationSmbRequest::GetUser ( ) const
inline

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Definition at line 267 of file CreateLocationSmbRequest.h.

◆ MountOptionsHasBeenSet()

bool Aws::DataSync::Model::CreateLocationSmbRequest::MountOptionsHasBeenSet ( ) const
inline

The mount options used by DataSync to access the SMB server.

Definition at line 479 of file CreateLocationSmbRequest.h.

◆ PasswordHasBeenSet()

bool Aws::DataSync::Model::CreateLocationSmbRequest::PasswordHasBeenSet ( ) const
inline

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Definition at line 377 of file CreateLocationSmbRequest.h.

◆ SerializePayload()

Aws::String Aws::DataSync::Model::CreateLocationSmbRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServerHostnameHasBeenSet()

bool Aws::DataSync::Model::CreateLocationSmbRequest::ServerHostnameHasBeenSet ( ) const
inline

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Definition at line 204 of file CreateLocationSmbRequest.h.

◆ SetAgentArns() [1/2]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetAgentArns ( Aws::Vector< Aws::String > &&  value)
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 438 of file CreateLocationSmbRequest.h.

◆ SetAgentArns() [2/2]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetAgentArns ( const Aws::Vector< Aws::String > &  value)
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 432 of file CreateLocationSmbRequest.h.

◆ SetDomain() [1/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetDomain ( Aws::String &&  value)
inline

The name of the Windows domain that the SMB server belongs to.

Definition at line 344 of file CreateLocationSmbRequest.h.

◆ SetDomain() [2/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetDomain ( const Aws::String value)
inline

The name of the Windows domain that the SMB server belongs to.

Definition at line 339 of file CreateLocationSmbRequest.h.

◆ SetDomain() [3/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetDomain ( const char *  value)
inline

The name of the Windows domain that the SMB server belongs to.

Definition at line 349 of file CreateLocationSmbRequest.h.

◆ SetMountOptions() [1/2]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetMountOptions ( const SmbMountOptions value)
inline

The mount options used by DataSync to access the SMB server.

Definition at line 484 of file CreateLocationSmbRequest.h.

◆ SetMountOptions() [2/2]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetMountOptions ( SmbMountOptions &&  value)
inline

The mount options used by DataSync to access the SMB server.

Definition at line 489 of file CreateLocationSmbRequest.h.

◆ SetPassword() [1/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetPassword ( Aws::String &&  value)
inline

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Definition at line 389 of file CreateLocationSmbRequest.h.

◆ SetPassword() [2/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetPassword ( const Aws::String value)
inline

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Definition at line 383 of file CreateLocationSmbRequest.h.

◆ SetPassword() [3/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetPassword ( const char *  value)
inline

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Definition at line 395 of file CreateLocationSmbRequest.h.

◆ SetServerHostname() [1/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetServerHostname ( Aws::String &&  value)
inline

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Definition at line 222 of file CreateLocationSmbRequest.h.

◆ SetServerHostname() [2/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetServerHostname ( const Aws::String value)
inline

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Definition at line 213 of file CreateLocationSmbRequest.h.

◆ SetServerHostname() [3/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetServerHostname ( const char *  value)
inline

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Definition at line 231 of file CreateLocationSmbRequest.h.

◆ SetSubdirectory() [1/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetSubdirectory ( Aws::String &&  value)
inline

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Definition at line 113 of file CreateLocationSmbRequest.h.

◆ SetSubdirectory() [2/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetSubdirectory ( const Aws::String value)
inline

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Definition at line 95 of file CreateLocationSmbRequest.h.

◆ SetSubdirectory() [3/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetSubdirectory ( const char *  value)
inline

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Definition at line 131 of file CreateLocationSmbRequest.h.

◆ SetTags() [1/2]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetTags ( Aws::Vector< TagListEntry > &&  value)
inline

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Definition at line 528 of file CreateLocationSmbRequest.h.

◆ SetTags() [2/2]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetTags ( const Aws::Vector< TagListEntry > &  value)
inline

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Definition at line 521 of file CreateLocationSmbRequest.h.

◆ SetUser() [1/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetUser ( Aws::String &&  value)
inline

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Definition at line 291 of file CreateLocationSmbRequest.h.

◆ SetUser() [2/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetUser ( const Aws::String value)
inline

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Definition at line 283 of file CreateLocationSmbRequest.h.

◆ SetUser() [3/3]

void Aws::DataSync::Model::CreateLocationSmbRequest::SetUser ( const char *  value)
inline

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Definition at line 299 of file CreateLocationSmbRequest.h.

◆ SubdirectoryHasBeenSet()

bool Aws::DataSync::Model::CreateLocationSmbRequest::SubdirectoryHasBeenSet ( ) const
inline

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Definition at line 77 of file CreateLocationSmbRequest.h.

◆ TagsHasBeenSet()

bool Aws::DataSync::Model::CreateLocationSmbRequest::TagsHasBeenSet ( ) const
inline

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Definition at line 514 of file CreateLocationSmbRequest.h.

◆ UserHasBeenSet()

bool Aws::DataSync::Model::CreateLocationSmbRequest::UserHasBeenSet ( ) const
inline

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Definition at line 275 of file CreateLocationSmbRequest.h.

◆ WithAgentArns() [1/2]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithAgentArns ( Aws::Vector< Aws::String > &&  value)
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 450 of file CreateLocationSmbRequest.h.

◆ WithAgentArns() [2/2]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithAgentArns ( const Aws::Vector< Aws::String > &  value)
inline

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Definition at line 444 of file CreateLocationSmbRequest.h.

◆ WithDomain() [1/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithDomain ( Aws::String &&  value)
inline

The name of the Windows domain that the SMB server belongs to.

Definition at line 359 of file CreateLocationSmbRequest.h.

◆ WithDomain() [2/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithDomain ( const Aws::String value)
inline

The name of the Windows domain that the SMB server belongs to.

Definition at line 354 of file CreateLocationSmbRequest.h.

◆ WithDomain() [3/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithDomain ( const char *  value)
inline

The name of the Windows domain that the SMB server belongs to.

Definition at line 364 of file CreateLocationSmbRequest.h.

◆ WithMountOptions() [1/2]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithMountOptions ( const SmbMountOptions value)
inline

The mount options used by DataSync to access the SMB server.

Definition at line 494 of file CreateLocationSmbRequest.h.

◆ WithMountOptions() [2/2]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithMountOptions ( SmbMountOptions &&  value)
inline

The mount options used by DataSync to access the SMB server.

Definition at line 499 of file CreateLocationSmbRequest.h.

◆ WithPassword() [1/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithPassword ( Aws::String &&  value)
inline

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Definition at line 407 of file CreateLocationSmbRequest.h.

◆ WithPassword() [2/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithPassword ( const Aws::String value)
inline

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Definition at line 401 of file CreateLocationSmbRequest.h.

◆ WithPassword() [3/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithPassword ( const char *  value)
inline

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

Definition at line 413 of file CreateLocationSmbRequest.h.

◆ WithServerHostname() [1/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithServerHostname ( Aws::String &&  value)
inline

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Definition at line 249 of file CreateLocationSmbRequest.h.

◆ WithServerHostname() [2/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithServerHostname ( const Aws::String value)
inline

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Definition at line 240 of file CreateLocationSmbRequest.h.

◆ WithServerHostname() [3/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithServerHostname ( const char *  value)
inline

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Definition at line 258 of file CreateLocationSmbRequest.h.

◆ WithSubdirectory() [1/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithSubdirectory ( Aws::String &&  value)
inline

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Definition at line 167 of file CreateLocationSmbRequest.h.

◆ WithSubdirectory() [2/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithSubdirectory ( const Aws::String value)
inline

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Definition at line 149 of file CreateLocationSmbRequest.h.

◆ WithSubdirectory() [3/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithSubdirectory ( const char *  value)
inline

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Definition at line 185 of file CreateLocationSmbRequest.h.

◆ WithTags() [1/2]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithTags ( Aws::Vector< TagListEntry > &&  value)
inline

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Definition at line 542 of file CreateLocationSmbRequest.h.

◆ WithTags() [2/2]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithTags ( const Aws::Vector< TagListEntry > &  value)
inline

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Definition at line 535 of file CreateLocationSmbRequest.h.

◆ WithUser() [1/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithUser ( Aws::String &&  value)
inline

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Definition at line 315 of file CreateLocationSmbRequest.h.

◆ WithUser() [2/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithUser ( const Aws::String value)
inline

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Definition at line 307 of file CreateLocationSmbRequest.h.

◆ WithUser() [3/3]

CreateLocationSmbRequest& Aws::DataSync::Model::CreateLocationSmbRequest::WithUser ( const char *  value)
inline

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

Definition at line 323 of file CreateLocationSmbRequest.h.


The documentation for this class was generated from the following file: