Skip to main content

@swamp/aws/datasync

v2026.04.23.3

AWS DATASYNC infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsdatasynccloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/datasync

@swamp/aws/datasync/agentv2026.04.23.2agent.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AgentName?stringThe name configured for the agent. Text reference used to identify the agent in the console.
ActivationKey?stringActivation key of the Agent.
SecurityGroupArns?arrayThe ARNs of the security group used to protect your data transfer task subnets.
SubnetArns?arrayThe ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
VpcEndpointId?stringThe ID of the VPC endpoint that the agent has access to.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a DataSync Agent
getGet a DataSync Agent
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync Agent
updateUpdate a DataSync Agent
deleteDelete a DataSync Agent
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync Agent
syncSync DataSync Agent state from AWS

Resources

state(infinite)— DataSync Agent resource state
@swamp/aws/datasync/location-azure-blobv2026.04.23.2location_azure_blob.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AgentArns?arraySpecifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
AzureBlobAuthenticationTypeenumThe specific authentication type that you want DataSync to use to access your Azure Blob Container.
AzureBlobSasConfiguration?objectSpecifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.
AzureBlobContainerUrl?stringThe URL of the Azure Blob container that was described.
AzureBlobType?enumSpecifies a blob type for the objects you're transferring into your Azure Blob Storage container.
AzureAccessTier?enumSpecifies an access tier for the objects you're transferring into your Azure Blob Storage container.
Subdirectory?stringThe subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
Tags?arrayAn array of key-value pairs to apply to this resource.
CmkSecretConfig?objectSpecifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
CustomSecretConfig?objectSpecifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
createCreate a DataSync LocationAzureBlob
getGet a DataSync LocationAzureBlob
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationAzureBlob
updateUpdate a DataSync LocationAzureBlob
deleteDelete a DataSync LocationAzureBlob
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationAzureBlob
syncSync DataSync LocationAzureBlob state from AWS

Resources

state(infinite)— DataSync LocationAzureBlob resource state
@swamp/aws/datasync/location-efsv2026.04.23.2location_efs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Ec2ConfigobjectThe subnet and security group that DataSync uses to access target EFS file system.
EfsFilesystemArn?stringThe Amazon Resource Name (ARN) for the Amazon EFS file system.
AccessPointArn?stringThe Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
FileSystemAccessRoleArn?stringThe Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
InTransitEncryption?enumProtocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
Subdirectory?stringA subdirectory in the location's path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a DataSync LocationEFS
getGet a DataSync LocationEFS
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationEFS
updateUpdate a DataSync LocationEFS
deleteDelete a DataSync LocationEFS
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationEFS
syncSync DataSync LocationEFS state from AWS

Resources

state(infinite)— DataSync LocationEFS resource state
@swamp/aws/datasync/location-fsx-lustrev2026.04.23.2location_fsx_lustre.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
FsxFilesystemArn?stringThe Amazon Resource Name (ARN) for the FSx for Lustre file system.
SecurityGroupArnsarrayThe ARNs of the security groups that are to use to configure the FSx for Lustre file system.
Subdirectory?stringA subdirectory in the location's path.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a DataSync LocationFSxLustre
getGet a DataSync LocationFSxLustre
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationFSxLustre
updateUpdate a DataSync LocationFSxLustre
deleteDelete a DataSync LocationFSxLustre
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationFSxLustre
syncSync DataSync LocationFSxLustre state from AWS

Resources

state(infinite)— DataSync LocationFSxLustre resource state
@swamp/aws/datasync/location-fsx-ontapv2026.04.23.2location_fsx_ontap.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
StorageVirtualMachineArnstringThe Amazon Resource Name (ARN) for the FSx ONTAP SVM.
SecurityGroupArnsarrayThe ARNs of the security groups that are to use to configure the FSx ONTAP file system.
Protocol?objectConfiguration settings for NFS or SMB protocol.
Subdirectory?stringA subdirectory in the location's path.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a DataSync LocationFSxONTAP
getGet a DataSync LocationFSxONTAP
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationFSxONTAP
updateUpdate a DataSync LocationFSxONTAP
deleteDelete a DataSync LocationFSxONTAP
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationFSxONTAP
syncSync DataSync LocationFSxONTAP state from AWS

Resources

state(infinite)— DataSync LocationFSxONTAP resource state
@swamp/aws/datasync/location-fsx-open-zfsv2026.04.23.2location_fsx_open_zfs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
FsxFilesystemArn?stringThe Amazon Resource Name (ARN) for the FSx OpenZFS file system.
SecurityGroupArnsarrayThe ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
ProtocolobjectConfiguration settings for an NFS or SMB protocol, currently only support NFS
Subdirectory?stringA subdirectory in the location's path.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a DataSync LocationFSxOpenZFS
getGet a DataSync LocationFSxOpenZFS
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationFSxOpenZFS
updateUpdate a DataSync LocationFSxOpenZFS
deleteDelete a DataSync LocationFSxOpenZFS
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationFSxOpenZFS
syncSync DataSync LocationFSxOpenZFS state from AWS

Resources

state(infinite)— DataSync LocationFSxOpenZFS resource state
@swamp/aws/datasync/location-fsx-windowsv2026.04.23.2location_fsx_windows.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Domain?stringThe name of the Windows domain that the FSx for Windows server belongs to.
FsxFilesystemArn?stringThe Amazon Resource Name (ARN) for the FSx for Windows file system.
Password?stringThe password of the user who has the permissions to access files and folders in the FSx for Windows file system.
SecurityGroupArnsarrayThe ARNs of the security groups that are to use to configure the FSx for Windows file system.
Subdirectory?stringA subdirectory in the location's path.
UserstringThe user who has the permissions to access files and folders in the FSx for Windows file system.
Tags?arrayAn array of key-value pairs to apply to this resource.
CmkSecretConfig?objectSpecifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
CustomSecretConfig?objectSpecifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
createCreate a DataSync LocationFSxWindows
getGet a DataSync LocationFSxWindows
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationFSxWindows
updateUpdate a DataSync LocationFSxWindows
deleteDelete a DataSync LocationFSxWindows
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationFSxWindows
syncSync DataSync LocationFSxWindows state from AWS

Resources

state(infinite)— DataSync LocationFSxWindows resource state
@swamp/aws/datasync/location-hdfsv2026.04.23.2location_hdfs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NameNodesarrayAn array of Name Node(s) of the HDFS location.
BlockSize?numberSize of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
ReplicationFactor?numberNumber of copies of each block that exists inside the HDFS cluster.
KmsKeyProviderUri?stringThe identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
QopConfiguration?objectConfiguration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.
AuthenticationTypeenumThe authentication mode used to determine identity of user.
SimpleUser?stringThe user name that has read and write permissions on the specified HDFS cluster.
KerberosPrincipal?stringThe unique identity, or principal, to which Kerberos can assign tickets.
KerberosKeytab?stringThe Base64 string representation of the Keytab file.
KerberosKrb5Conf?stringThe string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
Tags?arrayAn array of key-value pairs to apply to this resource.
AgentArnsarrayARN(s) of the agent(s) to use for an HDFS location.
Subdirectory?stringThe subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
CmkSecretConfig?objectSpecifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
CustomSecretConfig?objectSpecifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
createCreate a DataSync LocationHDFS
getGet a DataSync LocationHDFS
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationHDFS
updateUpdate a DataSync LocationHDFS
deleteDelete a DataSync LocationHDFS
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationHDFS
syncSync DataSync LocationHDFS state from AWS

Resources

state(infinite)— DataSync LocationHDFS resource state
@swamp/aws/datasync/location-nfsv2026.04.23.2location_nfs.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
MountOptions?objectThe NFS mount options that DataSync can use to mount your NFS share.
OnPremConfigobjectContains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.
ServerHostname?stringThe name of the NFS server. This value is the IP address or DNS name of the NFS server.
Subdirectory?stringThe subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a DataSync LocationNFS
getGet a DataSync LocationNFS
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationNFS
updateUpdate a DataSync LocationNFS
deleteDelete a DataSync LocationNFS
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationNFS
syncSync DataSync LocationNFS state from AWS

Resources

state(infinite)— DataSync LocationNFS resource state
@swamp/aws/datasync/location-object-storagev2026.04.23.2location_object_storage.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AccessKey?stringOptional. The access key is used if credentials are required to access the self-managed object storage server.
AgentArns?arraySpecifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.
BucketName?stringThe name of the bucket on the self-managed object storage server.
SecretKey?stringOptional. The secret key is used if credentials are required to access the self-managed object storage server.
ServerCertificate?stringX.509 PEM content containing a certificate authority or chain to trust.
ServerHostname?stringThe name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server.
ServerPort?numberThe port that your self-managed server accepts inbound network traffic on.
ServerProtocol?enumThe protocol that the object storage server uses to communicate.
Subdirectory?stringThe subdirectory in the self-managed object storage server that is used to read data from.
Tags?arrayAn array of key-value pairs to apply to this resource.
CmkSecretConfig?objectSpecifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
CustomSecretConfig?objectSpecifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
createCreate a DataSync LocationObjectStorage
getGet a DataSync LocationObjectStorage
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationObjectStorage
updateUpdate a DataSync LocationObjectStorage
deleteDelete a DataSync LocationObjectStorage
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationObjectStorage
syncSync DataSync LocationObjectStorage state from AWS

Resources

state(infinite)— DataSync LocationObjectStorage resource state
@swamp/aws/datasync/location-s3v2026.04.23.2location_s3.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
S3ConfigobjectThe Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.
S3BucketArn?stringThe Amazon Resource Name (ARN) of the Amazon S3 bucket.
Subdirectory?stringA subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
S3StorageClass?enumThe Amazon S3 storage class you want to store your files in when this location is used as a task destination.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a DataSync LocationS3
getGet a DataSync LocationS3
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationS3
updateUpdate a DataSync LocationS3
deleteDelete a DataSync LocationS3
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationS3
syncSync DataSync LocationS3 state from AWS

Resources

state(infinite)— DataSync LocationS3 resource state
@swamp/aws/datasync/location-smbv2026.04.23.2location_smb.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AgentArnsarrayThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
Domain?stringThe name of the Windows domain that the SMB server belongs to.
MountOptions?objectThe mount options used by DataSync to access the SMB server.
Password?stringThe password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
ServerHostname?stringThe name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
Subdirectory?stringThe subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
User?stringThe user who can mount the share, has the permissions to access files and folders in the SMB share.
Tags?arrayAn array of key-value pairs to apply to this resource.
AuthenticationType?enumThe authentication mode used to determine identity of user.
DnsIpAddresses?arraySpecifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
KerberosPrincipal?stringSpecifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
KerberosKeytab?stringThe Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
KerberosKrb5Conf?stringThe string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
CmkSecretConfig?objectSpecifies configuration information for a DataSync-managed secret, such as a password or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.
CustomSecretConfig?objectSpecifies configuration information for a customer-managed secret, such as a password or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.
createCreate a DataSync LocationSMB
getGet a DataSync LocationSMB
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationSMB
updateUpdate a DataSync LocationSMB
deleteDelete a DataSync LocationSMB
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync LocationSMB
syncSync DataSync LocationSMB state from AWS

Resources

state(infinite)— DataSync LocationSMB resource state
@swamp/aws/datasync/taskv2026.04.23.2task.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Excludes?array
Includes?array
Tags?arrayAn array of key-value pairs to apply to this resource.
CloudWatchLogGroupArn?stringThe ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
DestinationLocationArnstringThe ARN of an AWS storage resource's location.
Name?stringThe name of a task. This value is a text reference that is used to identify the task in the console.
Options?objectRepresents the options that are available to control the behavior of a StartTaskExecution operation.
TaskReportConfig?objectSpecifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.
ManifestConfig?objectConfigures a manifest, which is a list of files or objects that you want DataSync to transfer.
Schedule?objectSpecifies the schedule you want your task to use for repeated executions.
SourceLocationArnstringThe ARN of the source location for the task.
TaskMode?enumSpecifies the task mode for the task.
createCreate a DataSync Task
getGet a DataSync Task
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync Task
updateUpdate a DataSync Task
deleteDelete a DataSync Task
ArgumentTypeDescription
identifierstringThe primary identifier of the DataSync Task
syncSync DataSync Task state from AWS

Resources

state(infinite)— DataSync Task resource state