public static interface CreateAgentRequest.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateAgentRequest.Builder |
activationKey(String activationKey)
Your agent activation key.
|
CreateAgentRequest.Builder |
agentName(String agentName)
The name you configured for your agent.
|
CreateAgentRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateAgentRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateAgentRequest.Builder |
securityGroupArns(Collection<String> securityGroupArns)
The ARNs of the security groups used to protect your data transfer task subnets.
|
CreateAgentRequest.Builder |
securityGroupArns(String... securityGroupArns)
The ARNs of the security groups used to protect your data transfer task subnets.
|
CreateAgentRequest.Builder |
subnetArns(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.Builder |
subnetArns(String... subnetArns)
The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for
each data transfer task.
|
CreateAgentRequest.Builder |
tags(Collection<TagListEntry> tags)
The key-value pair that represents the tag that you want to associate with the agent.
|
CreateAgentRequest.Builder |
tags(Consumer<TagListEntry.Builder>... tags)
The key-value pair that represents the tag that you want to associate with the agent.
|
CreateAgentRequest.Builder |
tags(TagListEntry... tags)
The key-value pair that represents the tag that you want to associate with the agent.
|
CreateAgentRequest.Builder |
vpcEndpointId(String vpcEndpointId)
The ID of the VPC (virtual private cloud) endpoint that the agent has access to.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateAgentRequest.Builder activationKey(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 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.
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.
CreateAgentRequest.Builder agentName(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.
agentName - The name you configured for your agent. This value is a text reference that is used to identify the
agent in the console.CreateAgentRequest.Builder tags(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: + - = . _ : / @.
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: + - = . _ : / @.
CreateAgentRequest.Builder tags(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: + - = . _ : / @.
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: + - = . _ : / @.
CreateAgentRequest.Builder tags(Consumer<TagListEntry.Builder>... 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: + - = . _ : / @.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateAgentRequest.Builder vpcEndpointId(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.
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.
CreateAgentRequest.Builder subnetArns(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.
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.CreateAgentRequest.Builder subnetArns(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.
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.CreateAgentRequest.Builder securityGroupArns(Collection<String> securityGroupArns)
The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.
securityGroupArns - The ARNs of the security groups used to protect your data transfer task subnets. See
CreateAgentRequest$SubnetArns.CreateAgentRequest.Builder securityGroupArns(String... securityGroupArns)
The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.
securityGroupArns - The ARNs of the security groups used to protect your data transfer task subnets. See
CreateAgentRequest$SubnetArns.CreateAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.