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

#include <CreateAgentRequest.h>

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

Public Member Functions

 CreateAgentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetActivationKey () const
 
bool ActivationKeyHasBeenSet () const
 
void SetActivationKey (const Aws::String &value)
 
void SetActivationKey (Aws::String &&value)
 
void SetActivationKey (const char *value)
 
CreateAgentRequestWithActivationKey (const Aws::String &value)
 
CreateAgentRequestWithActivationKey (Aws::String &&value)
 
CreateAgentRequestWithActivationKey (const char *value)
 
const Aws::StringGetAgentName () const
 
bool AgentNameHasBeenSet () const
 
void SetAgentName (const Aws::String &value)
 
void SetAgentName (Aws::String &&value)
 
void SetAgentName (const char *value)
 
CreateAgentRequestWithAgentName (const Aws::String &value)
 
CreateAgentRequestWithAgentName (Aws::String &&value)
 
CreateAgentRequestWithAgentName (const char *value)
 
const Aws::Vector< TagListEntry > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< TagListEntry > &value)
 
void SetTags (Aws::Vector< TagListEntry > &&value)
 
CreateAgentRequestWithTags (const Aws::Vector< TagListEntry > &value)
 
CreateAgentRequestWithTags (Aws::Vector< TagListEntry > &&value)
 
CreateAgentRequestAddTags (const TagListEntry &value)
 
CreateAgentRequestAddTags (TagListEntry &&value)
 
const Aws::StringGetVpcEndpointId () const
 
bool VpcEndpointIdHasBeenSet () const
 
void SetVpcEndpointId (const Aws::String &value)
 
void SetVpcEndpointId (Aws::String &&value)
 
void SetVpcEndpointId (const char *value)
 
CreateAgentRequestWithVpcEndpointId (const Aws::String &value)
 
CreateAgentRequestWithVpcEndpointId (Aws::String &&value)
 
CreateAgentRequestWithVpcEndpointId (const char *value)
 
const Aws::Vector< Aws::String > & GetSubnetArns () const
 
bool SubnetArnsHasBeenSet () const
 
void SetSubnetArns (const Aws::Vector< Aws::String > &value)
 
void SetSubnetArns (Aws::Vector< Aws::String > &&value)
 
CreateAgentRequestWithSubnetArns (const Aws::Vector< Aws::String > &value)
 
CreateAgentRequestWithSubnetArns (Aws::Vector< Aws::String > &&value)
 
CreateAgentRequestAddSubnetArns (const Aws::String &value)
 
CreateAgentRequestAddSubnetArns (Aws::String &&value)
 
CreateAgentRequestAddSubnetArns (const char *value)
 
const Aws::Vector< Aws::String > & GetSecurityGroupArns () const
 
bool SecurityGroupArnsHasBeenSet () const
 
void SetSecurityGroupArns (const Aws::Vector< Aws::String > &value)
 
void SetSecurityGroupArns (Aws::Vector< Aws::String > &&value)
 
CreateAgentRequestWithSecurityGroupArns (const Aws::Vector< Aws::String > &value)
 
CreateAgentRequestWithSecurityGroupArns (Aws::Vector< Aws::String > &&value)
 
CreateAgentRequestAddSecurityGroupArns (const Aws::String &value)
 
CreateAgentRequestAddSecurityGroupArns (Aws::String &&value)
 
CreateAgentRequestAddSecurityGroupArns (const char *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

CreateAgentRequest

See Also:

AWS API Reference

Definition at line 26 of file CreateAgentRequest.h.

Constructor & Destructor Documentation

◆ CreateAgentRequest()

Aws::DataSync::Model::CreateAgentRequest::CreateAgentRequest ( )

Member Function Documentation

◆ ActivationKeyHasBeenSet()

bool Aws::DataSync::Model::CreateAgentRequest::ActivationKeyHasBeenSet ( ) const
inline

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.

Definition at line 66 of file CreateAgentRequest.h.

◆ AddSecurityGroupArns() [1/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::AddSecurityGroupArns ( const Aws::String value)
inline

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

Definition at line 490 of file CreateAgentRequest.h.

◆ AddSecurityGroupArns() [2/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::AddSecurityGroupArns ( Aws::String &&  value)
inline

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

Definition at line 496 of file CreateAgentRequest.h.

◆ AddSecurityGroupArns() [3/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::AddSecurityGroupArns ( const char *  value)
inline

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

Definition at line 502 of file CreateAgentRequest.h.

◆ AddSubnetArns() [1/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::AddSubnetArns ( const Aws::String value)
inline

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.

Definition at line 425 of file CreateAgentRequest.h.

◆ AddSubnetArns() [2/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::AddSubnetArns ( Aws::String &&  value)
inline

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.

Definition at line 436 of file CreateAgentRequest.h.

◆ AddSubnetArns() [3/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::AddSubnetArns ( const char *  value)
inline

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.

Definition at line 447 of file CreateAgentRequest.h.

◆ AddTags() [1/2]

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

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: + - = . _ : / .

Definition at line 257 of file CreateAgentRequest.h.

◆ AddTags() [2/2]

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

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: + - = . _ : / .

Definition at line 266 of file CreateAgentRequest.h.

◆ AgentNameHasBeenSet()

bool Aws::DataSync::Model::CreateAgentRequest::AgentNameHasBeenSet ( ) const
inline

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

Definition at line 157 of file CreateAgentRequest.h.

◆ GetActivationKey()

const Aws::String& Aws::DataSync::Model::CreateAgentRequest::GetActivationKey ( ) const
inline

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.

Definition at line 53 of file CreateAgentRequest.h.

◆ GetAgentName()

const Aws::String& Aws::DataSync::Model::CreateAgentRequest::GetAgentName ( ) const
inline

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

Definition at line 151 of file CreateAgentRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::DataSync::DataSyncRequest.

◆ GetSecurityGroupArns()

const Aws::Vector<Aws::String>& Aws::DataSync::Model::CreateAgentRequest::GetSecurityGroupArns ( ) const
inline

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

Definition at line 454 of file CreateAgentRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateAgentRequest.h.

◆ GetSubnetArns()

const Aws::Vector<Aws::String>& Aws::DataSync::Model::CreateAgentRequest::GetSubnetArns ( ) const
inline

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.

Definition at line 359 of file CreateAgentRequest.h.

◆ GetTags()

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

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: + - = . _ : / .

Definition at line 203 of file CreateAgentRequest.h.

◆ GetVpcEndpointId()

const Aws::String& Aws::DataSync::Model::CreateAgentRequest::GetVpcEndpointId ( ) const
inline

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.

Definition at line 277 of file CreateAgentRequest.h.

◆ SecurityGroupArnsHasBeenSet()

bool Aws::DataSync::Model::CreateAgentRequest::SecurityGroupArnsHasBeenSet ( ) const
inline

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

Definition at line 460 of file CreateAgentRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetActivationKey() [1/3]

void Aws::DataSync::Model::CreateAgentRequest::SetActivationKey ( const Aws::String value)
inline

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.

Definition at line 79 of file CreateAgentRequest.h.

◆ SetActivationKey() [2/3]

void Aws::DataSync::Model::CreateAgentRequest::SetActivationKey ( Aws::String &&  value)
inline

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.

Definition at line 92 of file CreateAgentRequest.h.

◆ SetActivationKey() [3/3]

void Aws::DataSync::Model::CreateAgentRequest::SetActivationKey ( const char *  value)
inline

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.

Definition at line 105 of file CreateAgentRequest.h.

◆ SetAgentName() [1/3]

void Aws::DataSync::Model::CreateAgentRequest::SetAgentName ( const Aws::String value)
inline

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

Definition at line 163 of file CreateAgentRequest.h.

◆ SetAgentName() [2/3]

void Aws::DataSync::Model::CreateAgentRequest::SetAgentName ( Aws::String &&  value)
inline

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

Definition at line 169 of file CreateAgentRequest.h.

◆ SetAgentName() [3/3]

void Aws::DataSync::Model::CreateAgentRequest::SetAgentName ( const char *  value)
inline

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

Definition at line 175 of file CreateAgentRequest.h.

◆ SetSecurityGroupArns() [1/2]

void Aws::DataSync::Model::CreateAgentRequest::SetSecurityGroupArns ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 466 of file CreateAgentRequest.h.

◆ SetSecurityGroupArns() [2/2]

void Aws::DataSync::Model::CreateAgentRequest::SetSecurityGroupArns ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 472 of file CreateAgentRequest.h.

◆ SetSubnetArns() [1/2]

void Aws::DataSync::Model::CreateAgentRequest::SetSubnetArns ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 381 of file CreateAgentRequest.h.

◆ SetSubnetArns() [2/2]

void Aws::DataSync::Model::CreateAgentRequest::SetSubnetArns ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 392 of file CreateAgentRequest.h.

◆ SetTags() [1/2]

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

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: + - = . _ : / .

Definition at line 221 of file CreateAgentRequest.h.

◆ SetTags() [2/2]

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

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: + - = . _ : / .

Definition at line 230 of file CreateAgentRequest.h.

◆ SetVpcEndpointId() [1/3]

void Aws::DataSync::Model::CreateAgentRequest::SetVpcEndpointId ( const Aws::String value)
inline

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.

Definition at line 297 of file CreateAgentRequest.h.

◆ SetVpcEndpointId() [2/3]

void Aws::DataSync::Model::CreateAgentRequest::SetVpcEndpointId ( Aws::String &&  value)
inline

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.

Definition at line 307 of file CreateAgentRequest.h.

◆ SetVpcEndpointId() [3/3]

void Aws::DataSync::Model::CreateAgentRequest::SetVpcEndpointId ( const char *  value)
inline

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.

Definition at line 317 of file CreateAgentRequest.h.

◆ SubnetArnsHasBeenSet()

bool Aws::DataSync::Model::CreateAgentRequest::SubnetArnsHasBeenSet ( ) const
inline

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.

Definition at line 370 of file CreateAgentRequest.h.

◆ TagsHasBeenSet()

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

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: + - = . _ : / .

Definition at line 212 of file CreateAgentRequest.h.

◆ VpcEndpointIdHasBeenSet()

bool Aws::DataSync::Model::CreateAgentRequest::VpcEndpointIdHasBeenSet ( ) const
inline

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.

Definition at line 287 of file CreateAgentRequest.h.

◆ WithActivationKey() [1/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithActivationKey ( const Aws::String value)
inline

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.

Definition at line 118 of file CreateAgentRequest.h.

◆ WithActivationKey() [2/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithActivationKey ( Aws::String &&  value)
inline

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.

Definition at line 131 of file CreateAgentRequest.h.

◆ WithActivationKey() [3/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithActivationKey ( const char *  value)
inline

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.

Definition at line 144 of file CreateAgentRequest.h.

◆ WithAgentName() [1/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithAgentName ( const Aws::String value)
inline

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

Definition at line 181 of file CreateAgentRequest.h.

◆ WithAgentName() [2/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithAgentName ( Aws::String &&  value)
inline

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

Definition at line 187 of file CreateAgentRequest.h.

◆ WithAgentName() [3/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithAgentName ( const char *  value)
inline

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

Definition at line 193 of file CreateAgentRequest.h.

◆ WithSecurityGroupArns() [1/2]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithSecurityGroupArns ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 478 of file CreateAgentRequest.h.

◆ WithSecurityGroupArns() [2/2]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithSecurityGroupArns ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 484 of file CreateAgentRequest.h.

◆ WithSubnetArns() [1/2]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithSubnetArns ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 403 of file CreateAgentRequest.h.

◆ WithSubnetArns() [2/2]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithSubnetArns ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 414 of file CreateAgentRequest.h.

◆ WithTags() [1/2]

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

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: + - = . _ : / .

Definition at line 239 of file CreateAgentRequest.h.

◆ WithTags() [2/2]

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

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: + - = . _ : / .

Definition at line 248 of file CreateAgentRequest.h.

◆ WithVpcEndpointId() [1/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithVpcEndpointId ( const Aws::String value)
inline

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.

Definition at line 327 of file CreateAgentRequest.h.

◆ WithVpcEndpointId() [2/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithVpcEndpointId ( Aws::String &&  value)
inline

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.

Definition at line 337 of file CreateAgentRequest.h.

◆ WithVpcEndpointId() [3/3]

CreateAgentRequest& Aws::DataSync::Model::CreateAgentRequest::WithVpcEndpointId ( const char *  value)
inline

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.

Definition at line 347 of file CreateAgentRequest.h.


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