Package 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(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	Description
CfnAgent.Builder	activationKey(String activationKey)	Specifies your DataSync agent's activation key.
CfnAgent.Builder	agentName(String agentName)	Specifies a name 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)	Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint.
CfnAgent.Builder	tags(List<? extends CfnTag> tags)	Specifies labels that help you categorize, filter, and search for your AWS resources.
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 Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAgent.Builder.

activationKey

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-activationkey

agentName

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-agentname

securityGroupArns

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-securitygrouparns

subnetArns

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-subnetarns

tags

@Stability(Stable)
public CfnAgent.Builder tags(List<? extends CfnTag> tags)

Specifies labels that help you categorize, filter, and search for your AWS resources.

We recommend creating at least one tag for your agent.

Parameters:

tags - Specifies labels that help you categorize, filter, and search for your AWS resources. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-tags

vpcEndpointId

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-agent.html#cfn-datasync-agent-vpcendpointid

build

@Stability(Stable)
public CfnAgent build()

Specified by:

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

Returns:

a newly built instance of CfnAgent.