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() Specifies your DataSync agent's activation key.
String	getAgentName() Specifies a name for your agent.
List<String>	getSecurityGroupArns() Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint.
List<String>	getSubnetArns() Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.
List<TagListEntry>	getTags() Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
String	getVpcEndpointId() Specifies the ID of the VPC endpoint that you want your agent to connect to.
int	hashCode()
void	setActivationKey(String activationKey) Specifies your DataSync agent's activation key.
void	setAgentName(String agentName) Specifies a name for your agent.
void	setSecurityGroupArns(Collection<String> securityGroupArns) Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint.
void	setSubnetArns(Collection<String> subnetArns) Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.
void	setTags(Collection<TagListEntry> tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
void	setVpcEndpointId(String vpcEndpointId) Specifies the ID of the VPC endpoint that you want your agent to connect to.
String	toString() Returns a string representation of this object.
CreateAgentRequest	withActivationKey(String activationKey) Specifies your DataSync agent's activation key.
CreateAgentRequest	withAgentName(String agentName) Specifies a name for your agent.
CreateAgentRequest	withSecurityGroupArns(Collection<String> securityGroupArns) Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint.
CreateAgentRequest	withSecurityGroupArns(String... securityGroupArns) Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint.
CreateAgentRequest	withSubnetArns(Collection<String> subnetArns) Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.
CreateAgentRequest	withSubnetArns(String... subnetArns) Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.
CreateAgentRequest	withTags(Collection<TagListEntry> tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
CreateAgentRequest	withTags(TagListEntry... tags) Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
CreateAgentRequest	withVpcEndpointId(String vpcEndpointId) Specifies the ID of the VPC endpoint that you want your agent to connect 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)

Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.

Parameters:

activationKey - Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.

getActivationKey

public String getActivationKey()

Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.

Returns:

Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.

withActivationKey

public CreateAgentRequest withActivationKey(String activationKey)

Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.

Parameters:

activationKey - Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.

Returns:

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

setAgentName

public void setAgentName(String agentName)

Specifies a name for your agent. You can see this name in the DataSync console.

Parameters:

agentName - Specifies a name for your agent. You can see this name in the DataSync console.

getAgentName

public String getAgentName()

Specifies a name for your agent. You can see this name in the DataSync console.

Returns:

Specifies a name for your agent. You can see this name in the DataSync console.

withAgentName

public CreateAgentRequest withAgentName(String agentName)

Specifies a name for your agent. You can see this name in the DataSync console.

Parameters:

agentName - Specifies a name for your agent. You can see this name in the DataSync console.

Returns:

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

getTags

public List<TagListEntry> getTags()

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

Returns:

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

setTags

public void setTags(Collection<TagListEntry> tags)

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

Parameters:

tags - Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

withTags

public CreateAgentRequest withTags(TagListEntry... tags)

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

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 - Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

Returns:

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

withTags

public CreateAgentRequest withTags(Collection<TagListEntry> tags)

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

Parameters:

tags - Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.

Returns:

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

setVpcEndpointId

public void setVpcEndpointId(String vpcEndpointId)

Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

Parameters:

vpcEndpointId - Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

getVpcEndpointId

public String getVpcEndpointId()

Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

Returns:

Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

withVpcEndpointId

public CreateAgentRequest withVpcEndpointId(String vpcEndpointId)

Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

Parameters:

vpcEndpointId - Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1.

The VPC endpoint you use must include the DataSync service name (for example, com.amazonaws.us-east-2.datasync).

Returns:

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

getSubnetArns

public List<String> getSubnetArns()

Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

Returns:

Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

setSubnetArns

public void setSubnetArns(Collection<String> subnetArns)

Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

Parameters:

subnetArns - Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

withSubnetArns

public CreateAgentRequest withSubnetArns(String... subnetArns)

Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

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 - Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

Returns:

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

withSubnetArns

public CreateAgentRequest withSubnetArns(Collection<String> subnetArns)

Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

Parameters:

subnetArns - Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.

Returns:

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

getSecurityGroupArns

public List<String> getSecurityGroupArns()

Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

Returns:

Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

setSecurityGroupArns

public void setSecurityGroupArns(Collection<String> securityGroupArns)

Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

Parameters:

securityGroupArns - Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

withSecurityGroupArns

public CreateAgentRequest withSecurityGroupArns(String... securityGroupArns)

Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

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 - Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

Returns:

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

withSecurityGroupArns

public CreateAgentRequest withSecurityGroupArns(Collection<String> securityGroupArns)

Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

Parameters:

securityGroupArns - Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.

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()