software.amazon.awscdk.services.datasync

Class CfnAgent.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnAgent.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgent>

Enclosing class:

CfnAgent

@Stability(value=Stable)
public static final class CfnAgent.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAgent>

A fluent builder for CfnAgent.

Method Summary

Modifier and Type	Method and Description
CfnAgent.Builder	activationKey(String activationKey) Your agent activation key.
CfnAgent.Builder	agentName(String agentName) The name you configured for your agent.
CfnAgent	build()
static CfnAgent.Builder	create(software.constructs.Construct scope, String id)
CfnAgent.Builder	securityGroupArns(List<String> securityGroupArns) The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
CfnAgent.Builder	subnetArns(List<String> subnetArns) The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
CfnAgent.Builder	tags(List<? extends CfnTag> tags) The key-value pair that represents the tag that you want to associate with the agent.
CfnAgent.Builder	vpcEndpointId(String vpcEndpointId) The ID of the virtual private cloud (VPC) endpoint that the agent has access to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnAgent.Builder create(software.constructs.Construct scope,
                                                               String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnAgent.Builder.

activationKey

@Stability(value=Stable)
public CfnAgent.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 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 Creating and activating an agent in the AWS DataSync User Guide.

Parameters:

activationKey - Your agent activation key. This parameter is required.

Returns:

this

agentName

@Stability(value=Stable)
public CfnAgent.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.

Parameters:

agentName - The name you configured for your agent. This parameter is required.

Returns:

this

securityGroupArns

@Stability(value=Stable)
public CfnAgent.Builder securityGroupArns(List<String> securityGroupArns)

The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.

See SecurityGroupArns .

Pattern : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$

Parameters:

securityGroupArns - The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets. This parameter is required.

Returns:

this

subnetArns

@Stability(value=Stable)
public CfnAgent.Builder subnetArns(List<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. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnAgent.Builder tags(List<? extends CfnTag> 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. This parameter is required.

Returns:

this

vpcEndpointId

@Stability(value=Stable)
public CfnAgent.Builder vpcEndpointId(String vpcEndpointId)

The ID of the virtual private cloud (VPC) endpoint that the agent has access to.

This is the client-side VPC endpoint, powered by AWS PrivateLink . If you don't have an AWS PrivateLink VPC endpoint, see AWS PrivateLink and VPC endpoints in the Amazon VPC User Guide .

For more information about activating your agent in a private network based on a VPC, see Using AWS DataSync in a Virtual Private Cloud in the AWS DataSync User Guide.

A VPC endpoint ID looks like this: vpce-01234d5aff67890e1 .

Parameters:

vpcEndpointId - The ID of the virtual private cloud (VPC) endpoint that the agent has access to. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnAgent build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAgent>