/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace DataSync { namespace Model { /** *

CreateLocationSmbRequest

See Also:

AWS * API Reference

*/ class AWS_DATASYNC_API CreateLocationSmbRequest : public DataSyncRequest { public: CreateLocationSmbRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateLocationSmb"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

*/ inline const Aws::String& GetSubdirectory() const{ return m_subdirectory; } /** *

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.

*/ inline bool SubdirectoryHasBeenSet() const { return m_subdirectoryHasBeenSet; } /** *

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.

*/ inline void SetSubdirectory(const Aws::String& value) { m_subdirectoryHasBeenSet = true; m_subdirectory = value; } /** *

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.

*/ inline void SetSubdirectory(Aws::String&& value) { m_subdirectoryHasBeenSet = true; m_subdirectory = std::move(value); } /** *

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.

*/ inline void SetSubdirectory(const char* value) { m_subdirectoryHasBeenSet = true; m_subdirectory.assign(value); } /** *

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.

*/ inline CreateLocationSmbRequest& WithSubdirectory(const Aws::String& value) { SetSubdirectory(value); return *this;} /** *

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.

*/ inline CreateLocationSmbRequest& WithSubdirectory(Aws::String&& value) { SetSubdirectory(std::move(value)); return *this;} /** *

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.

*/ inline CreateLocationSmbRequest& WithSubdirectory(const char* value) { SetSubdirectory(value); return *this;} /** *

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.

* */ inline const Aws::String& GetServerHostname() const{ return m_serverHostname; } /** *

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.

* */ inline bool ServerHostnameHasBeenSet() const { return m_serverHostnameHasBeenSet; } /** *

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.

* */ inline void SetServerHostname(const Aws::String& value) { m_serverHostnameHasBeenSet = true; m_serverHostname = value; } /** *

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.

* */ inline void SetServerHostname(Aws::String&& value) { m_serverHostnameHasBeenSet = true; m_serverHostname = std::move(value); } /** *

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.

* */ inline void SetServerHostname(const char* value) { m_serverHostnameHasBeenSet = true; m_serverHostname.assign(value); } /** *

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.

* */ inline CreateLocationSmbRequest& WithServerHostname(const Aws::String& value) { SetServerHostname(value); return *this;} /** *

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.

* */ inline CreateLocationSmbRequest& WithServerHostname(Aws::String&& value) { SetServerHostname(std::move(value)); return *this;} /** *

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.

* */ inline CreateLocationSmbRequest& WithServerHostname(const char* value) { SetServerHostname(value); return *this;} /** *

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

*/ inline const Aws::String& GetUser() const{ return m_user; } /** *

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

*/ inline bool UserHasBeenSet() const { return m_userHasBeenSet; } /** *

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

*/ inline void SetUser(const Aws::String& value) { m_userHasBeenSet = true; m_user = value; } /** *

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

*/ inline void SetUser(Aws::String&& value) { m_userHasBeenSet = true; m_user = std::move(value); } /** *

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

*/ inline void SetUser(const char* value) { m_userHasBeenSet = true; m_user.assign(value); } /** *

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

*/ inline CreateLocationSmbRequest& WithUser(const Aws::String& value) { SetUser(value); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& WithUser(Aws::String&& value) { SetUser(std::move(value)); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& WithUser(const char* value) { SetUser(value); return *this;} /** *

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

*/ inline const Aws::String& GetDomain() const{ return m_domain; } /** *

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

*/ inline bool DomainHasBeenSet() const { return m_domainHasBeenSet; } /** *

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

*/ inline void SetDomain(const Aws::String& value) { m_domainHasBeenSet = true; m_domain = value; } /** *

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

*/ inline void SetDomain(Aws::String&& value) { m_domainHasBeenSet = true; m_domain = std::move(value); } /** *

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

*/ inline void SetDomain(const char* value) { m_domainHasBeenSet = true; m_domain.assign(value); } /** *

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

*/ inline CreateLocationSmbRequest& WithDomain(const Aws::String& value) { SetDomain(value); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& WithDomain(Aws::String&& value) { SetDomain(std::move(value)); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& WithDomain(const char* value) { SetDomain(value); return *this;} /** *

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

*/ inline const Aws::String& GetPassword() const{ return m_password; } /** *

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

*/ inline bool PasswordHasBeenSet() const { return m_passwordHasBeenSet; } /** *

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

*/ inline void SetPassword(const Aws::String& value) { m_passwordHasBeenSet = true; m_password = value; } /** *

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

*/ inline void SetPassword(Aws::String&& value) { m_passwordHasBeenSet = true; m_password = std::move(value); } /** *

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

*/ inline void SetPassword(const char* value) { m_passwordHasBeenSet = true; m_password.assign(value); } /** *

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

*/ inline CreateLocationSmbRequest& WithPassword(const Aws::String& value) { SetPassword(value); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& WithPassword(Aws::String&& value) { SetPassword(std::move(value)); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& WithPassword(const char* value) { SetPassword(value); return *this;} /** *

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

*/ inline const Aws::Vector& GetAgentArns() const{ return m_agentArns; } /** *

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

*/ inline bool AgentArnsHasBeenSet() const { return m_agentArnsHasBeenSet; } /** *

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

*/ inline void SetAgentArns(const Aws::Vector& value) { m_agentArnsHasBeenSet = true; m_agentArns = value; } /** *

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

*/ inline void SetAgentArns(Aws::Vector&& value) { m_agentArnsHasBeenSet = true; m_agentArns = std::move(value); } /** *

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

*/ inline CreateLocationSmbRequest& WithAgentArns(const Aws::Vector& value) { SetAgentArns(value); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& WithAgentArns(Aws::Vector&& value) { SetAgentArns(std::move(value)); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& AddAgentArns(const Aws::String& value) { m_agentArnsHasBeenSet = true; m_agentArns.push_back(value); return *this; } /** *

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

*/ inline CreateLocationSmbRequest& AddAgentArns(Aws::String&& value) { m_agentArnsHasBeenSet = true; m_agentArns.push_back(std::move(value)); return *this; } /** *

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

*/ inline CreateLocationSmbRequest& AddAgentArns(const char* value) { m_agentArnsHasBeenSet = true; m_agentArns.push_back(value); return *this; } /** *

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

*/ inline const SmbMountOptions& GetMountOptions() const{ return m_mountOptions; } /** *

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

*/ inline bool MountOptionsHasBeenSet() const { return m_mountOptionsHasBeenSet; } /** *

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

*/ inline void SetMountOptions(const SmbMountOptions& value) { m_mountOptionsHasBeenSet = true; m_mountOptions = value; } /** *

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

*/ inline void SetMountOptions(SmbMountOptions&& value) { m_mountOptionsHasBeenSet = true; m_mountOptions = std::move(value); } /** *

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

*/ inline CreateLocationSmbRequest& WithMountOptions(const SmbMountOptions& value) { SetMountOptions(value); return *this;} /** *

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

*/ inline CreateLocationSmbRequest& WithMountOptions(SmbMountOptions&& value) { SetMountOptions(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

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.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

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.

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

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.

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

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.

*/ inline CreateLocationSmbRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

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.

*/ inline CreateLocationSmbRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

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.

*/ inline CreateLocationSmbRequest& AddTags(const TagListEntry& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

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.

*/ inline CreateLocationSmbRequest& AddTags(TagListEntry&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } private: Aws::String m_subdirectory; bool m_subdirectoryHasBeenSet; Aws::String m_serverHostname; bool m_serverHostnameHasBeenSet; Aws::String m_user; bool m_userHasBeenSet; Aws::String m_domain; bool m_domainHasBeenSet; Aws::String m_password; bool m_passwordHasBeenSet; Aws::Vector m_agentArns; bool m_agentArnsHasBeenSet; SmbMountOptions m_mountOptions; bool m_mountOptionsHasBeenSet; Aws::Vector m_tags; bool m_tagsHasBeenSet; }; } // namespace Model } // namespace DataSync } // namespace Aws