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 Details

    • 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 the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<TagListEntry>).

      Parameters:
      tags - a consumer that will call methods on TagListEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 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.

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAgentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.