com.amazonaws.services.datasync.model

Class CreateAgentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datasync.model.CreateAgentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAgentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

CreateAgentRequest

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAgentRequest()

Method Summary

Modifier and Type	Method and Description
CreateAgentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getActivationKey() Your agent activation key.
String	getAgentName() The name you configured for your agent.
List<String>	getSecurityGroupArns() The ARNs of the security groups used to protect your data transfer task subnets.
List<String>	getSubnetArns() The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
List<TagListEntry>	getTags() The key-value pair that represents the tag that you want to associate with the agent.
String	getVpcEndpointId() The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
int	hashCode()
void	setActivationKey(String activationKey) Your agent activation key.
void	setAgentName(String agentName) The name you configured for your agent.
void	setSecurityGroupArns(Collection<String> securityGroupArns) The ARNs of the security groups used to protect your data transfer task subnets.
void	setSubnetArns(Collection<String> subnetArns) The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
void	setTags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to associate with the agent.
void	setVpcEndpointId(String vpcEndpointId) The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
String	toString() Returns a string representation of this object.
CreateAgentRequest	withActivationKey(String activationKey) Your agent activation key.
CreateAgentRequest	withAgentName(String agentName) The name you configured for your agent.
CreateAgentRequest	withSecurityGroupArns(Collection<String> securityGroupArns) The ARNs of the security groups used to protect your data transfer task subnets.
CreateAgentRequest	withSecurityGroupArns(String... securityGroupArns) The ARNs of the security groups used to protect your data transfer task subnets.
CreateAgentRequest	withSubnetArns(Collection<String> subnetArns) The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
CreateAgentRequest	withSubnetArns(String... subnetArns) The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
CreateAgentRequest	withTags(Collection<TagListEntry> tags) The key-value pair that represents the tag that you want to associate with the agent.
CreateAgentRequest	withTags(TagListEntry... tags) The key-value pair that represents the tag that you want to associate with the agent.
CreateAgentRequest	withVpcEndpointId(String vpcEndpointId) The ID of the VPC (virtual private cloud) endpoint that the agent has access to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAgentRequest

public CreateAgentRequest()

Method Detail

setActivationKey

public void setActivationKey(String 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 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 DataSync User Guide.

Parameters:

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 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 DataSync User Guide.

getActivationKey

public String getActivationKey()

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 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 DataSync User Guide.

Returns:

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 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 DataSync User Guide.

withActivationKey

public CreateAgentRequest withActivationKey(String 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 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 DataSync User Guide.

Parameters:

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 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 DataSync User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAgentName

public void setAgentName(String agentName)

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

Parameters:

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

getAgentName

public String getAgentName()

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

Returns:

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

withAgentName

public CreateAgentRequest withAgentName(String agentName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<TagListEntry> getTags()

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

Returns:

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

setTags

public void setTags(Collection<TagListEntry> 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: + - = . _ : / @.

Parameters:

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

withTags

public CreateAgentRequest withTags(TagListEntry... 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: + - = . _ : / @.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateAgentRequest withTags(Collection<TagListEntry> 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: + - = . _ : / @.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setVpcEndpointId

public void setVpcEndpointId(String 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.

Parameters:

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.

getVpcEndpointId

public String getVpcEndpointId()

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.

Returns:

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.

withVpcEndpointId

public CreateAgentRequest withVpcEndpointId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSubnetArns

public List<String> getSubnetArns()

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.

Returns:

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.

setSubnetArns

public void setSubnetArns(Collection<String> 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.

Parameters:

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.

withSubnetArns

public CreateAgentRequest withSubnetArns(String... 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.

NOTE: This method appends the values to the existing list (if any). Use setSubnetArns(java.util.Collection) or withSubnetArns(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSubnetArns

public CreateAgentRequest withSubnetArns(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getSecurityGroupArns

public List<String> getSecurityGroupArns()

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

Returns:

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

setSecurityGroupArns

public void setSecurityGroupArns(Collection<String> securityGroupArns)

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

Parameters:

securityGroupArns - The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.

withSecurityGroupArns

public CreateAgentRequest withSecurityGroupArns(String... securityGroupArns)

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

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupArns(java.util.Collection) or withSecurityGroupArns(java.util.Collection) if you want to override the existing values.

Parameters:

securityGroupArns - The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityGroupArns

public CreateAgentRequest withSecurityGroupArns(Collection<String> securityGroupArns)

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

Parameters:

securityGroupArns - The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAgentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()