Interface CreateAgentRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>,DataSyncRequest.Builder,SdkBuilder<CreateAgentRequest.Builder,CreateAgentRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateAgentRequest
public static interface CreateAgentRequest.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateAgentRequest.BuilderactivationKey(String activationKey)Specifies your DataSync agent's activation key.CreateAgentRequest.BuilderagentName(String agentName)Specifies a name for your agent.CreateAgentRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateAgentRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateAgentRequest.BuildersecurityGroupArns(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.BuildersecurityGroupArns(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.BuildersubnetArns(String... subnetArns)Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.CreateAgentRequest.BuildersubnetArns(Collection<String> subnetArns)Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.CreateAgentRequest.Buildertags(Collection<TagListEntry> tags)Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.CreateAgentRequest.Buildertags(Consumer<TagListEntry.Builder>... tags)Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.CreateAgentRequest.Buildertags(TagListEntry... tags)Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.CreateAgentRequest.BuildervpcEndpointId(String vpcEndpointId)Specifies the ID of the VPC endpoint that you want your agent to connect to.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
activationKey
CreateAgentRequest.Builder activationKey(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.
-
agentName
CreateAgentRequest.Builder agentName(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.
-
tags
CreateAgentRequest.Builder tags(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.
-
tags
CreateAgentRequest.Builder tags(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.
-
tags
CreateAgentRequest.Builder tags(Consumer<TagListEntry.Builder>... 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.
This is a convenience method that creates an instance of theTagListEntry.Builderavoiding the need to create one manually viaTagListEntry.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTagListEntry.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
vpcEndpointId
CreateAgentRequest.Builder vpcEndpointId(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 likevpce-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.
-
subnetArns
CreateAgentRequest.Builder subnetArns(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.
-
subnetArns
CreateAgentRequest.Builder subnetArns(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.
-
securityGroupArns
CreateAgentRequest.Builder securityGroupArns(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.
-
securityGroupArns
CreateAgentRequest.Builder securityGroupArns(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.
-
overrideConfiguration
CreateAgentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-