Aws/datasync

@swamp/aws/datasyncv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS

01README

AWS DATASYNC infrastructure models

02Release Notes

Updated: location_azure_blob, location_fsx_ontap, location_fsx_windows, location_hdfs, location_object_storage, location_smb, task

03Behaviors13

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

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AgentName?	string	no	The name configured for the agent. Text reference used to identify the agent in the console.
ActivationKey?	string	no	Activation key of the Agent.
SecurityGroupArns?	array	no	The ARNs of the security group used to protect your data transfer task subnets.
SubnetArns?	array	no	The ARNs of the subnets in which DataSync will create elastic network interfaces for each data transfer task.
VpcEndpointId?	string	no	The ID of the VPC endpoint that the agent has access to.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a DataSync Agent

fn get(identifier: string)

Get a DataSync Agent

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync Agent

fn update()

Update a DataSync Agent

fn delete(identifier: string)

Delete a DataSync Agent

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync Agent

fn sync()

Sync DataSync Agent state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync Agent resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync Agent resource state

@swamp/aws/datasync/location-azure-blobv2026.10.25.1location_azure_blob.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AgentArns?	array	no	Specifies 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.
AzureBlobAuthenticationType	enum	yes	The specific authentication type that you want DataSync to use to access your Azure Blob Container.
AzureBlobSasConfiguration?	object	no	Specifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.
AzureBlobContainerUrl?	string	no	The URL of the Azure Blob container that was described.
AzureBlobType?	enum	no	Specifies a blob type for the objects you're transferring into your Azure Blob Storage container.
AzureAccessTier?	enum	no	Specifies an access tier for the objects you're transferring into your Azure Blob Storage container.
Subdirectory?	string	no	The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location.
Tags?	array	no	An array of key-value pairs to apply to this resource.
CmkSecretConfig?	object	no	Specifies 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?	object	no	Specifies 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.
ManagedSecretConfig?	object	no	Specifies 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. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.
FederatedIdentity?	object	no	Specifies the identity federation configuration that DataSync uses to access your Azure Blob Storage container using an OpenID Connect (OIDC) token.

fn create()

Create a DataSync LocationAzureBlob

fn get(identifier: string)

Get a DataSync LocationAzureBlob

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationAzureBlob

fn update()

Update a DataSync LocationAzureBlob

fn delete(identifier: string)

Delete a DataSync LocationAzureBlob

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationAzureBlob

fn sync()

Sync DataSync LocationAzureBlob state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationAzureBlob resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationAzureBlob resource state

@swamp/aws/datasync/location-efsv2026.10.23.1location_efs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Ec2Config	object	yes	The subnet and security group that DataSync uses to access target EFS file system.
EfsFilesystemArn?	string	no	The Amazon Resource Name (ARN) for the Amazon EFS file system.
AccessPointArn?	string	no	The Amazon Resource Name (ARN) for the Amazon EFS Access point that DataSync uses when accessing the EFS file system.
FileSystemAccessRoleArn?	string	no	The Amazon Resource Name (ARN) of the AWS IAM role that the DataSync will assume when mounting the EFS file system.
InTransitEncryption?	enum	no	Protocol that is used for encrypting the traffic exchanged between the DataSync Agent and the EFS file system.
Subdirectory?	string	no	A 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?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a DataSync LocationEFS

fn get(identifier: string)

Get a DataSync LocationEFS

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationEFS

fn update()

Update a DataSync LocationEFS

fn delete(identifier: string)

Delete a DataSync LocationEFS

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationEFS

fn sync()

Sync DataSync LocationEFS state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationEFS resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationEFS resource state

@swamp/aws/datasync/location-fsx-lustrev2026.10.23.1location_fsx_lustre.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
FsxFilesystemArn?	string	no	The Amazon Resource Name (ARN) for the FSx for Lustre file system.
SecurityGroupArns	array	yes	The ARNs of the security groups that are to use to configure the FSx for Lustre file system.
Subdirectory?	string	no	A subdirectory in the location's path.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a DataSync LocationFSxLustre

fn get(identifier: string)

Get a DataSync LocationFSxLustre

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationFSxLustre

fn update()

Update a DataSync LocationFSxLustre

fn delete(identifier: string)

Delete a DataSync LocationFSxLustre

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationFSxLustre

fn sync()

Sync DataSync LocationFSxLustre state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationFSxLustre resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationFSxLustre resource state

@swamp/aws/datasync/location-fsx-ontapv2026.10.25.1location_fsx_ontap.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
StorageVirtualMachineArn	string	yes	The Amazon Resource Name (ARN) for the FSx ONTAP SVM.
SecurityGroupArns	array	yes	The ARNs of the security groups that are to use to configure the FSx ONTAP file system.
Protocol?	object	no	Configuration settings for NFS or SMB protocol.
Subdirectory?	string	no	A subdirectory in the location's path.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a DataSync LocationFSxONTAP

fn get(identifier: string)

Get a DataSync LocationFSxONTAP

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationFSxONTAP

fn update()

Update a DataSync LocationFSxONTAP

fn delete(identifier: string)

Delete a DataSync LocationFSxONTAP

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationFSxONTAP

fn sync()

Sync DataSync LocationFSxONTAP state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationFSxONTAP resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationFSxONTAP resource state

@swamp/aws/datasync/location-fsx-open-zfsv2026.10.23.1location_fsx_open_zfs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
FsxFilesystemArn?	string	no	The Amazon Resource Name (ARN) for the FSx OpenZFS file system.
SecurityGroupArns	array	yes	The ARNs of the security groups that are to use to configure the FSx OpenZFS file system.
Protocol	object	yes	Configuration settings for an NFS or SMB protocol, currently only support NFS
Subdirectory?	string	no	A subdirectory in the location's path.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a DataSync LocationFSxOpenZFS

fn get(identifier: string)

Get a DataSync LocationFSxOpenZFS

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationFSxOpenZFS

fn update()

Update a DataSync LocationFSxOpenZFS

fn delete(identifier: string)

Delete a DataSync LocationFSxOpenZFS

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationFSxOpenZFS

fn sync()

Sync DataSync LocationFSxOpenZFS state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationFSxOpenZFS resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationFSxOpenZFS resource state

@swamp/aws/datasync/location-fsx-windowsv2026.10.25.1location_fsx_windows.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Domain?	string	no	The name of the Windows domain that the FSx for Windows server belongs to.
FsxFilesystemArn?	string	no	The Amazon Resource Name (ARN) for the FSx for Windows file system.
Password?	string	no	The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
SecurityGroupArns	array	yes	The ARNs of the security groups that are to use to configure the FSx for Windows file system.
Subdirectory?	string	no	A subdirectory in the location's path.
User	string	yes	The user who has the permissions to access files and folders in the FSx for Windows file system.
Tags?	array	no	An array of key-value pairs to apply to this resource.
CmkSecretConfig?	object	no	Specifies 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?	object	no	Specifies 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.
ManagedSecretConfig?	object	no	Specifies 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. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

fn create()

Create a DataSync LocationFSxWindows

fn get(identifier: string)

Get a DataSync LocationFSxWindows

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationFSxWindows

fn update()

Update a DataSync LocationFSxWindows

fn delete(identifier: string)

Delete a DataSync LocationFSxWindows

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationFSxWindows

fn sync()

Sync DataSync LocationFSxWindows state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationFSxWindows resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationFSxWindows resource state

@swamp/aws/datasync/location-hdfsv2026.10.25.1location_hdfs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
NameNodes	array	yes	An array of Name Node(s) of the HDFS location.
BlockSize?	number	no	Size of chunks (blocks) in bytes that the data is divided into when stored in the HDFS cluster.
ReplicationFactor?	number	no	Number of copies of each block that exists inside the HDFS cluster.
KmsKeyProviderUri?	string	no	The identifier for the Key Management Server where the encryption keys that encrypt data inside HDFS clusters are stored.
QopConfiguration?	object	no	Configuration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.
AuthenticationType	enum	yes	The authentication mode used to determine identity of user.
SimpleUser?	string	no	The user name that has read and write permissions on the specified HDFS cluster.
KerberosPrincipal?	string	no	The unique identity, or principal, to which Kerberos can assign tickets.
KerberosKeytab?	string	no	The Base64 string representation of the Keytab file.
KerberosKrb5Conf?	string	no	The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket.
Tags?	array	no	An array of key-value pairs to apply to this resource.
AgentArns	array	yes	ARN(s) of the agent(s) to use for an HDFS location.
Subdirectory?	string	no	The subdirectory in HDFS that is used to read data from the HDFS source location or write data to the HDFS destination.
CmkSecretConfig?	object	no	Specifies 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?	object	no	Specifies 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.
ManagedSecretConfig?	object	no	Specifies 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. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

fn create()

Create a DataSync LocationHDFS

fn get(identifier: string)

Get a DataSync LocationHDFS

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationHDFS

fn update()

Update a DataSync LocationHDFS

fn delete(identifier: string)

Delete a DataSync LocationHDFS

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationHDFS

fn sync()

Sync DataSync LocationHDFS state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationHDFS resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationHDFS resource state

@swamp/aws/datasync/location-nfsv2026.10.23.1location_nfs.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
MountOptions?	object	no	The NFS mount options that DataSync can use to mount your NFS share.
OnPremConfig	object	yes	Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.
ServerHostname?	string	no	The name of the NFS server. This value is the IP address or DNS name of the NFS server.
Subdirectory?	string	no	The 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?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a DataSync LocationNFS

fn get(identifier: string)

Get a DataSync LocationNFS

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationNFS

fn update()

Update a DataSync LocationNFS

fn delete(identifier: string)

Delete a DataSync LocationNFS

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationNFS

fn sync()

Sync DataSync LocationNFS state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationNFS resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationNFS resource state

@swamp/aws/datasync/location-object-storagev2026.10.25.1location_object_storage.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AccessKey?	string	no	Optional. The access key is used if credentials are required to access the self-managed object storage server.
AgentArns?	array	no	Specifies 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?	string	no	The name of the bucket on the self-managed object storage server.
SecretKey?	string	no	Optional. The secret key is used if credentials are required to access the self-managed object storage server.
ServerCertificate?	string	no	X.509 PEM content containing a certificate authority or chain to trust.
ServerHostname?	string	no	The 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?	number	no	The port that your self-managed server accepts inbound network traffic on.
ServerProtocol?	enum	no	The protocol that the object storage server uses to communicate.
Subdirectory?	string	no	The subdirectory in the self-managed object storage server that is used to read data from.
Tags?	array	no	An array of key-value pairs to apply to this resource.
CmkSecretConfig?	object	no	Specifies 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?	object	no	Specifies 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.
ManagedSecretConfig?	object	no	Specifies 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. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.
FederatedIdentity?	object	no	Specifies the identity federation configuration that DataSync uses to access your object storage location using an OpenID Connect (OIDC) token.

fn create()

Create a DataSync LocationObjectStorage

fn get(identifier: string)

Get a DataSync LocationObjectStorage

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationObjectStorage

fn update()

Update a DataSync LocationObjectStorage

fn delete(identifier: string)

Delete a DataSync LocationObjectStorage

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationObjectStorage

fn sync()

Sync DataSync LocationObjectStorage state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationObjectStorage resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationObjectStorage resource state

@swamp/aws/datasync/location-s3v2026.10.23.1location_s3.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
S3Config	object	yes	The Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.
S3BucketArn?	string	no	The Amazon Resource Name (ARN) of the Amazon S3 bucket.
Subdirectory?	string	no	A 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?	enum	no	The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a DataSync LocationS3

fn get(identifier: string)

Get a DataSync LocationS3

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationS3

fn update()

Update a DataSync LocationS3

fn delete(identifier: string)

Delete a DataSync LocationS3

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationS3

fn sync()

Sync DataSync LocationS3 state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationS3 resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationS3 resource state

@swamp/aws/datasync/location-smbv2026.10.25.1location_smb.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AgentArns	array	yes	The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
Domain?	string	no	The name of the Windows domain that the SMB server belongs to.
MountOptions?	object	no	The mount options used by DataSync to access the SMB server.
Password?	string	no	The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
ServerHostname?	string	no	The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
Subdirectory?	string	no	The 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?	string	no	The user who can mount the share, has the permissions to access files and folders in the SMB share.
Tags?	array	no	An array of key-value pairs to apply to this resource.
AuthenticationType?	enum	no	The authentication mode used to determine identity of user.
DnsIpAddresses?	array	no	Specifies 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?	string	no	Specifies 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?	string	no	The 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?	string	no	The 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?	object	no	Specifies 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?	object	no	Specifies 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.
ManagedSecretConfig?	object	no	Specifies configuration information for a DataSync-managed secret, such as a password or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

fn create()

Create a DataSync LocationSMB

fn get(identifier: string)

Get a DataSync LocationSMB

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationSMB

fn update()

Update a DataSync LocationSMB

fn delete(identifier: string)

Delete a DataSync LocationSMB

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync LocationSMB

fn sync()

Sync DataSync LocationSMB state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync LocationSMB resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync LocationSMB resource state

@swamp/aws/datasync/taskv2026.10.25.1task.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Excludes?	array	no
Includes?	array	no
Tags?	array	no	An array of key-value pairs to apply to this resource.
CloudWatchLogGroupArn?	string	no	The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
DestinationLocationArn	string	yes	The ARN of an AWS storage resource's location.
Name?	string	no	The name of a task. This value is a text reference that is used to identify the task in the console.
Options?	object	no	Represents the options that are available to control the behavior of a StartTaskExecution operation.
TaskReportConfig?	object	no	Specifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.
ManifestConfig?	object	no	Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
Schedule?	object	no	Specifies the schedule you want your task to use for repeated executions.
SourceLocationArn	string	yes	The ARN of the source location for the task.
TaskMode?	enum	no	Specifies the task mode for the task.

fn create()

Create a DataSync Task

fn get(identifier: string)

Get a DataSync Task

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync Task

fn update()

Update a DataSync Task

fn delete(identifier: string)

Delete a DataSync Task

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the DataSync Task

fn sync()

Sync DataSync Task state from AWS

fn list(maxPages?: number, resourceModel?: string)

List DataSync Task resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— DataSync Task resource state

04Previous Versions19

2026.10.24.1AGPL-3.0-or-laterOct 24, 2026

2026.10.23.1AGPL-3.0-or-laterOct 24, 2026

Updated: agent, location_azure_blob, location_efs, location_fsx_lustre, location_fsx_ontap, location_fsx_open_zfs, location_fsx_windows, location_hdfs, location_nfs, location_object_storage, location_s3, location_smb, task

2026.10.22.1AGPL-3.0-or-later(was none)Oct 22, 2026

Updated: task

2026.10.13.1Oct 13, 2026

Updated: agent, location_azure_blob, location_efs, location_fsx_lustre, location_fsx_ontap, location_fsx_open_zfs, location_fsx_windows, location_hdfs, location_nfs, location_object_storage, location_s3, location_smb, task

2026.10.08.1Oct 8, 2026

2026.10.06.1Oct 6, 2026

2026.10.04.1Oct 4, 2026

2026.10.03.1Oct 3, 2026

2026.10.02.1Oct 2, 2026

2026.10.01.1Oct 1, 2026

2026.09.30.1Sep 30, 2026

2026.09.29.1Sep 29, 2026

2026.09.28.1Sep 28, 2026

2026.09.27.1Sep 27, 2026

2026.09.26.1Sep 26, 2026

2026.09.25.1Sep 25, 2026

2026.09.24.1Sep 24, 2026

2026.09.23.1Sep 23, 2026

2026.09.22.1Sep 22, 2026

05Stats

100 / 100

Downloads

Archive size

2.6 MB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit2/2earned
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

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

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64 windows · x86_64

07Labels

#aws #datasync #cloud #infrastructure