AWS::DataSync::AgentCfnAgent
The `AWS::DataSync::Agent` resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers. The activation process associates the agent with your AWS account . For more information, see the following topics in the *AWS DataSync User Guide* : - [DataSync agent requirements](https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html) - [DataSync network requirements](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html) - [Create a DataSync agent](https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html)
Import
import { CfnAgent } from 'aws-cdk-lib/aws-datasync';Or use the module namespace:
import * as datasync from 'aws-cdk-lib/aws-datasync';
// datasync.CfnAgentProperties
Configuration passed to the constructor as CfnAgentProps.
activationKeyOptionalstringSpecifies your DataSync agent's activation key. If you don't have an activation key, see [Activating your agent](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html) .
agentNameOptionalstringSpecifies a name for your agent. We recommend specifying a name that you can remember.
securityGroupArnsOptionalstring[]The Amazon Resource Names (ARNs) of the security groups used to protect your data transfer task subnets. See [SecurityGroupArns](https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns) . *Pattern* : `^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$`
subnetArnsOptionalstring[]Specifies the ARN of the subnet where your VPC service endpoint is located. You can only specify one ARN.
tagsOptionalCfnTag[]Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least one tag for your agent.
vpcEndpointIdOptionalstringThe 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](https://docs.aws.amazon.com//vpc/latest/userguide/endpoint-services-overview.html) 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](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-in-vpc.html) in the *AWS DataSync User Guide.* A VPC endpoint ID looks like this: `vpce-01234d5aff67890e1` .
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-datasyncAWS::DataSync::Agent