Package software.amazon.awscdk.services.datasync

Class CfnAgentProps.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnAgentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgentProps>

Enclosing interface:

CfnAgentProps

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

A builder for CfnAgentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAgentProps.Builder	activationKey(String activationKey)	Sets the value of CfnAgentProps.getActivationKey()
CfnAgentProps.Builder	agentName(String agentName)	Sets the value of CfnAgentProps.getAgentName()
CfnAgentProps	build()	Builds the configured instance.
CfnAgentProps.Builder	securityGroupArns(List<String> securityGroupArns)	Sets the value of CfnAgentProps.getSecurityGroupArns()
CfnAgentProps.Builder	subnetArns(List<String> subnetArns)	Sets the value of CfnAgentProps.getSubnetArns()
CfnAgentProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnAgentProps.getTags()
CfnAgentProps.Builder	vpcEndpointId(String vpcEndpointId)	Sets the value of CfnAgentProps.getVpcEndpointId()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

activationKey

@Stability(Stable)
public CfnAgentProps.Builder activationKey(String activationKey)

Sets the value of CfnAgentProps.getActivationKey()

Parameters:

activationKey - Specifies your DataSync agent's activation key. If you don't have an activation key, see Activating your agent .

Returns:

this

agentName

@Stability(Stable)
public CfnAgentProps.Builder agentName(String agentName)

Sets the value of CfnAgentProps.getAgentName()

Parameters:

agentName - Specifies a name for your agent. We recommend specifying a name that you can remember.

Returns:

this

securityGroupArns

@Stability(Stable)
public CfnAgentProps.Builder securityGroupArns(List<String> securityGroupArns)

Sets the value of CfnAgentProps.getSecurityGroupArns()

Parameters:

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/.*$

Returns:

this

subnetArns

@Stability(Stable)
public CfnAgentProps.Builder subnetArns(List<String> subnetArns)

Sets the value of CfnAgentProps.getSubnetArns()

Parameters:

subnetArns - Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.

Returns:

this

tags

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

Sets the value of CfnAgentProps.getTags()

Parameters:

tags - Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least one tag for your agent.

Returns:

this

vpcEndpointId

@Stability(Stable)
public CfnAgentProps.Builder vpcEndpointId(String vpcEndpointId)

Sets the value of CfnAgentProps.getVpcEndpointId()

Parameters:

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 .

Returns:

this

build

@Stability(Stable)
public CfnAgentProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAgentProps

Throws:

NullPointerException - if any required attribute was not provided