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

CreateAgentRequest

See Also:

AWS * API Reference

*/ class AWS_DATASYNC_API CreateAgentRequest : public DataSyncRequest { public: CreateAgentRequest(); // 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 "CreateAgent"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

Your agent activation key. You can get the activation key either by sending * an HTTP GET request with redirects that enable you to get the agent IP address * (port 80). Alternatively, you can get it from the AWS DataSync console.

*

The redirect URL returned in the response provides you the activation key for * your agent in the query string parameter activationKey. It might * also include other activation-related parameters; however, these are merely * defaults. The arguments you pass to this API call determine the actual * configuration of your agent.

For more information, see Activating an * Agent in the AWS DataSync User Guide.

*/ inline const Aws::String& GetActivationKey() const{ return m_activationKey; } /** *

Your agent activation key. You can get the activation key either by sending * an HTTP GET request with redirects that enable you to get the agent IP address * (port 80). Alternatively, you can get it from the AWS DataSync console.

*

The redirect URL returned in the response provides you the activation key for * your agent in the query string parameter activationKey. It might * also include other activation-related parameters; however, these are merely * defaults. The arguments you pass to this API call determine the actual * configuration of your agent.

For more information, see Activating an * Agent in the AWS DataSync User Guide.

*/ inline bool ActivationKeyHasBeenSet() const { return m_activationKeyHasBeenSet; } /** *

Your agent activation key. You can get the activation key either by sending * an HTTP GET request with redirects that enable you to get the agent IP address * (port 80). Alternatively, you can get it from the AWS DataSync console.

*

The redirect URL returned in the response provides you the activation key for * your agent in the query string parameter activationKey. It might * also include other activation-related parameters; however, these are merely * defaults. The arguments you pass to this API call determine the actual * configuration of your agent.

For more information, see Activating an * Agent in the AWS DataSync User Guide.

*/ inline void SetActivationKey(const Aws::String& value) { m_activationKeyHasBeenSet = true; m_activationKey = value; } /** *

Your agent activation key. You can get the activation key either by sending * an HTTP GET request with redirects that enable you to get the agent IP address * (port 80). Alternatively, you can get it from the AWS DataSync console.

*

The redirect URL returned in the response provides you the activation key for * your agent in the query string parameter activationKey. It might * also include other activation-related parameters; however, these are merely * defaults. The arguments you pass to this API call determine the actual * configuration of your agent.

For more information, see Activating an * Agent in the AWS DataSync User Guide.

*/ inline void SetActivationKey(Aws::String&& value) { m_activationKeyHasBeenSet = true; m_activationKey = std::move(value); } /** *

Your agent activation key. You can get the activation key either by sending * an HTTP GET request with redirects that enable you to get the agent IP address * (port 80). Alternatively, you can get it from the AWS DataSync console.

*

The redirect URL returned in the response provides you the activation key for * your agent in the query string parameter activationKey. It might * also include other activation-related parameters; however, these are merely * defaults. The arguments you pass to this API call determine the actual * configuration of your agent.

For more information, see Activating an * Agent in the AWS DataSync User Guide.

*/ inline void SetActivationKey(const char* value) { m_activationKeyHasBeenSet = true; m_activationKey.assign(value); } /** *

Your agent activation key. You can get the activation key either by sending * an HTTP GET request with redirects that enable you to get the agent IP address * (port 80). Alternatively, you can get it from the AWS DataSync console.

*

The redirect URL returned in the response provides you the activation key for * your agent in the query string parameter activationKey. It might * also include other activation-related parameters; however, these are merely * defaults. The arguments you pass to this API call determine the actual * configuration of your agent.

For more information, see Activating an * Agent in the AWS DataSync User Guide.

*/ inline CreateAgentRequest& WithActivationKey(const Aws::String& value) { SetActivationKey(value); return *this;} /** *

Your agent activation key. You can get the activation key either by sending * an HTTP GET request with redirects that enable you to get the agent IP address * (port 80). Alternatively, you can get it from the AWS DataSync console.

*

The redirect URL returned in the response provides you the activation key for * your agent in the query string parameter activationKey. It might * also include other activation-related parameters; however, these are merely * defaults. The arguments you pass to this API call determine the actual * configuration of your agent.

For more information, see Activating an * Agent in the AWS DataSync User Guide.

*/ inline CreateAgentRequest& WithActivationKey(Aws::String&& value) { SetActivationKey(std::move(value)); return *this;} /** *

Your agent activation key. You can get the activation key either by sending * an HTTP GET request with redirects that enable you to get the agent IP address * (port 80). Alternatively, you can get it from the AWS DataSync console.

*

The redirect URL returned in the response provides you the activation key for * your agent in the query string parameter activationKey. It might * also include other activation-related parameters; however, these are merely * defaults. The arguments you pass to this API call determine the actual * configuration of your agent.

For more information, see Activating an * Agent in the AWS DataSync User Guide.

*/ inline CreateAgentRequest& WithActivationKey(const char* value) { SetActivationKey(value); return *this;} /** *

The name you configured for your agent. This value is a text reference that * is used to identify the agent in the console.

*/ inline const Aws::String& GetAgentName() const{ return m_agentName; } /** *

The name you configured for your agent. This value is a text reference that * is used to identify the agent in the console.

*/ inline bool AgentNameHasBeenSet() const { return m_agentNameHasBeenSet; } /** *

The name you configured for your agent. This value is a text reference that * is used to identify the agent in the console.

*/ inline void SetAgentName(const Aws::String& value) { m_agentNameHasBeenSet = true; m_agentName = value; } /** *

The name you configured for your agent. This value is a text reference that * is used to identify the agent in the console.

*/ inline void SetAgentName(Aws::String&& value) { m_agentNameHasBeenSet = true; m_agentName = std::move(value); } /** *

The name you configured for your agent. This value is a text reference that * is used to identify the agent in the console.

*/ inline void SetAgentName(const char* value) { m_agentNameHasBeenSet = true; m_agentName.assign(value); } /** *

The name you configured for your agent. This value is a text reference that * is used to identify the agent in the console.

*/ inline CreateAgentRequest& WithAgentName(const Aws::String& value) { SetAgentName(value); return *this;} /** *

The name you configured for your agent. This value is a text reference that * is used to identify the agent in the console.

*/ inline CreateAgentRequest& WithAgentName(Aws::String&& value) { SetAgentName(std::move(value)); return *this;} /** *

The name you configured for your agent. This value is a text reference that * is used to identify the agent in the console.

*/ inline CreateAgentRequest& WithAgentName(const char* value) { SetAgentName(value); return *this;} /** *

The key-value pair that represents the tag that you want to associate with * the agent. The value can be an empty string. This value helps you manage, * filter, and search for your agents.

Valid characters for key and * value are letters, spaces, and numbers representable in UTF-8 format, and the * following special characters: + - = . _ : / @.

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

The key-value pair that represents the tag that you want to associate with * the agent. The value can be an empty string. This value helps you manage, * filter, and search for your agents.

Valid characters for key and * value are letters, spaces, and numbers representable in UTF-8 format, and the * following special characters: + - = . _ : / @.

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

The key-value pair that represents the tag that you want to associate with * the agent. The value can be an empty string. This value helps you manage, * filter, and search for your agents.

Valid characters for key and * value are letters, spaces, and numbers representable in UTF-8 format, and the * following special characters: + - = . _ : / @.

*/ 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 associate with * the agent. The value can be an empty string. This value helps you manage, * filter, and search for your agents.

Valid characters for key and * value are letters, spaces, and numbers representable in UTF-8 format, and the * following special characters: + - = . _ : / @.

*/ 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 associate with * the agent. The value can be an empty string. This value helps you manage, * filter, and search for your agents.

Valid characters for key and * value are letters, spaces, and numbers representable in UTF-8 format, and the * following special characters: + - = . _ : / @.

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

The key-value pair that represents the tag that you want to associate with * the agent. The value can be an empty string. This value helps you manage, * filter, and search for your agents.

Valid characters for key and * value are letters, spaces, and numbers representable in UTF-8 format, and the * following special characters: + - = . _ : / @.

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

The key-value pair that represents the tag that you want to associate with * the agent. The value can be an empty string. This value helps you manage, * filter, and search for your agents.

Valid characters for key and * value are letters, spaces, and numbers representable in UTF-8 format, and the * following special characters: + - = . _ : / @.

*/ inline CreateAgentRequest& 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 associate with * the agent. The value can be an empty string. This value helps you manage, * filter, and search for your agents.

Valid characters for key and * value are letters, spaces, and numbers representable in UTF-8 format, and the * following special characters: + - = . _ : / @.

*/ inline CreateAgentRequest& AddTags(TagListEntry&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *

The ID of the VPC (virtual private cloud) endpoint that the agent has access * to. This is the client-side VPC endpoint, also called a PrivateLink. If you * don't have a PrivateLink VPC endpoint, see Creating * a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

*

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

*/ inline const Aws::String& GetVpcEndpointId() const{ return m_vpcEndpointId; } /** *

The ID of the VPC (virtual private cloud) endpoint that the agent has access * to. This is the client-side VPC endpoint, also called a PrivateLink. If you * don't have a PrivateLink VPC endpoint, see Creating * a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

*

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

*/ inline bool VpcEndpointIdHasBeenSet() const { return m_vpcEndpointIdHasBeenSet; } /** *

The ID of the VPC (virtual private cloud) endpoint that the agent has access * to. This is the client-side VPC endpoint, also called a PrivateLink. If you * don't have a PrivateLink VPC endpoint, see Creating * a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

*

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

*/ inline void SetVpcEndpointId(const Aws::String& value) { m_vpcEndpointIdHasBeenSet = true; m_vpcEndpointId = value; } /** *

The ID of the VPC (virtual private cloud) endpoint that the agent has access * to. This is the client-side VPC endpoint, also called a PrivateLink. If you * don't have a PrivateLink VPC endpoint, see Creating * a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

*

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

*/ inline void SetVpcEndpointId(Aws::String&& value) { m_vpcEndpointIdHasBeenSet = true; m_vpcEndpointId = std::move(value); } /** *

The ID of the VPC (virtual private cloud) endpoint that the agent has access * to. This is the client-side VPC endpoint, also called a PrivateLink. If you * don't have a PrivateLink VPC endpoint, see Creating * a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

*

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

*/ inline void SetVpcEndpointId(const char* value) { m_vpcEndpointIdHasBeenSet = true; m_vpcEndpointId.assign(value); } /** *

The ID of the VPC (virtual private cloud) endpoint that the agent has access * to. This is the client-side VPC endpoint, also called a PrivateLink. If you * don't have a PrivateLink VPC endpoint, see Creating * a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

*

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

*/ inline CreateAgentRequest& WithVpcEndpointId(const Aws::String& value) { SetVpcEndpointId(value); return *this;} /** *

The ID of the VPC (virtual private cloud) endpoint that the agent has access * to. This is the client-side VPC endpoint, also called a PrivateLink. If you * don't have a PrivateLink VPC endpoint, see Creating * a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

*

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

*/ inline CreateAgentRequest& WithVpcEndpointId(Aws::String&& value) { SetVpcEndpointId(std::move(value)); return *this;} /** *

The ID of the VPC (virtual private cloud) endpoint that the agent has access * to. This is the client-side VPC endpoint, also called a PrivateLink. If you * don't have a PrivateLink VPC endpoint, see Creating * a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

*

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

*/ inline CreateAgentRequest& WithVpcEndpointId(const char* value) { SetVpcEndpointId(value); return *this;} /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline const Aws::Vector& GetSubnetArns() const{ return m_subnetArns; } /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline bool SubnetArnsHasBeenSet() const { return m_subnetArnsHasBeenSet; } /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline void SetSubnetArns(const Aws::Vector& value) { m_subnetArnsHasBeenSet = true; m_subnetArns = value; } /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline void SetSubnetArns(Aws::Vector&& value) { m_subnetArnsHasBeenSet = true; m_subnetArns = std::move(value); } /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline CreateAgentRequest& WithSubnetArns(const Aws::Vector& value) { SetSubnetArns(value); return *this;} /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline CreateAgentRequest& WithSubnetArns(Aws::Vector&& value) { SetSubnetArns(std::move(value)); return *this;} /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline CreateAgentRequest& AddSubnetArns(const Aws::String& value) { m_subnetArnsHasBeenSet = true; m_subnetArns.push_back(value); return *this; } /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline CreateAgentRequest& AddSubnetArns(Aws::String&& value) { m_subnetArnsHasBeenSet = true; m_subnetArns.push_back(std::move(value)); return *this; } /** *

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create * elastic network interfaces for each data transfer task. The agent that runs a * task must be private. When you start a task that is associated with an agent * created in a VPC, or one that has access to an IP address in a VPC, then the * task is also private. In this case, DataSync creates four network interfaces for * each task in your subnet. For a data transfer to work, the agent must be able to * route to all these four network interfaces.

*/ inline CreateAgentRequest& AddSubnetArns(const char* value) { m_subnetArnsHasBeenSet = true; m_subnetArns.push_back(value); return *this; } /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline const Aws::Vector& GetSecurityGroupArns() const{ return m_securityGroupArns; } /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline bool SecurityGroupArnsHasBeenSet() const { return m_securityGroupArnsHasBeenSet; } /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline void SetSecurityGroupArns(const Aws::Vector& value) { m_securityGroupArnsHasBeenSet = true; m_securityGroupArns = value; } /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline void SetSecurityGroupArns(Aws::Vector&& value) { m_securityGroupArnsHasBeenSet = true; m_securityGroupArns = std::move(value); } /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline CreateAgentRequest& WithSecurityGroupArns(const Aws::Vector& value) { SetSecurityGroupArns(value); return *this;} /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline CreateAgentRequest& WithSecurityGroupArns(Aws::Vector&& value) { SetSecurityGroupArns(std::move(value)); return *this;} /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline CreateAgentRequest& AddSecurityGroupArns(const Aws::String& value) { m_securityGroupArnsHasBeenSet = true; m_securityGroupArns.push_back(value); return *this; } /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline CreateAgentRequest& AddSecurityGroupArns(Aws::String&& value) { m_securityGroupArnsHasBeenSet = true; m_securityGroupArns.push_back(std::move(value)); return *this; } /** *

The ARNs of the security groups used to protect your data transfer task * subnets. See CreateAgentRequest$SubnetArns.

*/ inline CreateAgentRequest& AddSecurityGroupArns(const char* value) { m_securityGroupArnsHasBeenSet = true; m_securityGroupArns.push_back(value); return *this; } private: Aws::String m_activationKey; bool m_activationKeyHasBeenSet; Aws::String m_agentName; bool m_agentNameHasBeenSet; Aws::Vector m_tags; bool m_tagsHasBeenSet; Aws::String m_vpcEndpointId; bool m_vpcEndpointIdHasBeenSet; Aws::Vector m_subnetArns; bool m_subnetArnsHasBeenSet; Aws::Vector m_securityGroupArns; bool m_securityGroupArnsHasBeenSet; }; } // namespace Model } // namespace DataSync } // namespace Aws