AWS Fundamentals Logo
AWS Fundamentals
AWS::DataSync::Agent

DataSync Agent

Resource schema for AWS::DataSync::Agent.

Properties

6 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
ActivationKey
string
Create-onlyWrite-only
AgentName
string
SecurityGroupArns
Array<string>
Create-only
SubnetArns
Array<string>
Create-only
Tags
Array<Tag>
VpcEndpointId
string
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
AgentArnstringThe DataSync Agent ARN.
EndpointTypestringThe service endpoints that the agent will connect to.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DataSync::Agent

Resources:
  MyResource:
    Type: AWS::DataSync::Agent
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

datasync:CreateAgentdatasync:TagResourcedatasync:DescribeAgentdatasync:ListTagsForResourceec2:DescribeNetworkInterfacesec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcEndpoints

read

datasync:DescribeAgentdatasync:ListTagsForResource

update

datasync:UpdateAgentdatasync:DescribeAgentdatasync:ListTagsForResourcedatasync:TagResourcedatasync:UntagResource

delete

datasync:DeleteAgent

list

datasync:ListAgents

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceDataSync
Properties8
Required0
TaggingSupported
Primary IDAgentArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ActivationKeySecurityGroupArnsSubnetArnsVpcEndpointId

Related Resources

External Links