/AWS1/CL_DSY=>CREATEAGENT()¶
About CreateAgent¶
Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.
If you haven't deployed an agent yet, see the following topics to learn more:
If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_ACTIVATIONKEY TYPE /AWS1/DSYACTIVATIONKEY /AWS1/DSYACTIVATIONKEY¶
Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.
Optional arguments:¶
IV_AGENTNAME TYPE /AWS1/DSYTAGVALUE /AWS1/DSYTAGVALUE¶
Specifies a name for your agent. You can see this name in the DataSync console.
IT_TAGS TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST TT_INPUTTAGLIST¶
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.
IV_VPCENDPOINTID TYPE /AWS1/DSYVPCENDPOINTID /AWS1/DSYVPCENDPOINTID¶
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).
IT_SUBNETARNS TYPE /AWS1/CL_DSYPLSUBNETARNLIST_W=>TT_PLSUBNETARNLIST TT_PLSUBNETARNLIST¶
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.
IT_SECURITYGROUPARNS TYPE /AWS1/CL_DSYPLSECGRPARNLIST_W=>TT_PLSECURITYGROUPARNLIST TT_PLSECURITYGROUPARNLIST¶
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.