Package software.amazon.awscdk.cfnpropertymixins.services.datasync

Class CfnAgentPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.datasync.CfnAgentPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgentPropsMixin>

Enclosing class:

CfnAgentPropsMixin

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

A fluent builder for CfnAgentPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAgentPropsMixin.Builder	activationKey(String activationKey)	Specifies your DataSync agent's activation key.
CfnAgentPropsMixin.Builder	agentName(String agentName)	Specifies a name for your agent.
CfnAgentPropsMixin	build()
static CfnAgentPropsMixin.Builder	create()
static CfnAgentPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAgentPropsMixin.Builder	securityGroupArns(List<String> securityGroupArns)	The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets.
CfnAgentPropsMixin.Builder	subnetArns(List<String> subnetArns)	Specifies the ARN of the subnet where your VPC service endpoint is located.
CfnAgentPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Specifies labels that help you categorize, filter, and search for your AWS resources.
CfnAgentPropsMixin.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 CfnAgentPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAgentPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAgentPropsMixin.Builder create()

Returns:

a new instance of CfnAgentPropsMixin.Builder.

activationKey

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

Specifies your DataSync agent's activation key.

If you don't have an activation key, see Activating 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 CfnAgentPropsMixin.Builder agentName(String agentName)

Specifies a name for your agent.

We recommend specifying a name that you can remember.

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 CfnAgentPropsMixin.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 CfnAgentPropsMixin.Builder subnetArns(List<String> subnetArns)

Specifies the ARN of the subnet where your VPC service endpoint is located.

You can only specify one ARN.

Parameters:

subnetArns - Specifies the ARN of the subnet where your VPC service endpoint is located. 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 CfnAgentPropsMixin.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 CfnAgentPropsMixin.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 CfnAgentPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnAgentPropsMixin.