aws-cdk-lib.aws_datasync

AWS::DataSync Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as datasync from 'aws-cdk-lib/aws-datasync';

import aws_cdk.aws_datasync as datasync

import software.amazon.awscdk.services.datasync.*;

using Amazon.CDK.AWS.DataSync;

import datasync "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for DataSync construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::DataSync resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::DataSync.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
CfnAgent	Construct (L1)	The AWS::DataSync::Agent resource activates an AWS DataSync agent that you've deployed for storage discovery or data transfers.
CfnLocationAzureBlob	Construct (L1)	Creates a transfer location for a Microsoft Azure Blob Storage container.
CfnLocationEFS	Construct (L1)	The AWS::DataSync::LocationEFS resource creates an endpoint for an Amazon EFS file system.
CfnLocationFSxLustre	Construct (L1)	The AWS::DataSync::LocationFSxLustre resource specifies an endpoint for an Amazon FSx for Lustre file system.
CfnLocationFSxONTAP	Construct (L1)	The AWS::DataSync::LocationFSxONTAP resource creates an endpoint for an Amazon FSx for NetApp ONTAP file system.
CfnLocationFSxOpenZFS	Construct (L1)	The AWS::DataSync::LocationFSxOpenZFS resource specifies an endpoint for an Amazon FSx for OpenZFS file system.
CfnLocationFSxWindows	Construct (L1)	The AWS::DataSync::LocationFSxWindows resource specifies an endpoint for an Amazon FSx for Windows Server file system.
CfnLocationHDFS	Construct (L1)	The AWS::DataSync::LocationHDFS resource specifies an endpoint for a Hadoop Distributed File System (HDFS).
CfnLocationNFS	Construct (L1)	The AWS::DataSync::LocationNFS resource specifies a Network File System (NFS) file server that AWS DataSync can use as a transfer source or destination.
CfnLocationObjectStorage	Construct (L1)	The AWS::DataSync::LocationObjectStorage resource specifies an endpoint for a self-managed object storage bucket.
CfnLocationS3	Construct (L1)	The AWS::DataSync::LocationS3 resource specifies an endpoint for an Amazon S3 bucket.
CfnLocationSMB	Construct (L1)	The AWS::DataSync::LocationSMB resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination.
CfnTask	Construct (L1)	The AWS::DataSync::Task resource specifies a task.
CfnAgentProps	Struct	Properties for defining a CfnAgent.
CfnLocationAzureBlob.AzureBlobSasConfigurationProperty	Struct	The shared access signature (SAS) configuration that allows AWS DataSync to access your Microsoft Azure Blob Storage.
CfnLocationAzureBlob.AzureFederatedIdentityConfigProperty	Struct	Specifies the identity federation configuration that DataSync uses to access your Azure Blob Storage container using an OpenID Connect (OIDC) token.
CfnLocationAzureBlob.AzureOidcConfigProperty	Struct	Specifies the Microsoft Entra (Azure AD) identity that DataSync federates with to obtain an access token for your Azure Blob Storage container.
CfnLocationAzureBlob.CmkSecretConfigProperty	Struct	Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
CfnLocationAzureBlob.CustomSecretConfigProperty	Struct	Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).
CfnLocationAzureBlob.ManagedSecretConfigProperty	Struct	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.
CfnLocationAzureBlobProps	Struct	Properties for defining a CfnLocationAzureBlob.
CfnLocationEFS.Ec2ConfigProperty	Struct	The subnet and security groups that AWS DataSync uses to connect to one of your Amazon EFS file system's mount targets .
CfnLocationEFSProps	Struct	Properties for defining a CfnLocationEFS.
CfnLocationFSxLustreProps	Struct	Properties for defining a CfnLocationFSxLustre.
CfnLocationFSxONTAP.CmkSecretConfigProperty	Struct	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.
CfnLocationFSxONTAP.CustomSecretConfigProperty	Struct	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.
CfnLocationFSxONTAP.ManagedSecretConfigProperty	Struct	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.
CfnLocationFSxONTAP.NfsMountOptionsProperty	Struct	Specifies how DataSync can access a location using the NFS protocol.
CfnLocationFSxONTAP.NFSProperty	Struct	Specifies the Network File System (NFS) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.
CfnLocationFSxONTAP.ProtocolProperty	Struct	Specifies the data transfer protocol that AWS DataSync uses to access your Amazon FSx file system.
CfnLocationFSxONTAP.SmbMountOptionsProperty	Struct	Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.
CfnLocationFSxONTAP.SMBProperty	Struct	Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access a storage virtual machine (SVM) on your Amazon FSx for NetApp ONTAP file system.
CfnLocationFSxONTAPProps	Struct	Properties for defining a CfnLocationFSxONTAP.
CfnLocationFSxOpenZFS.MountOptionsProperty	Struct	Represents the mount options that are available for DataSync to access a Network File System (NFS) location.
CfnLocationFSxOpenZFS.NFSProperty	Struct	Represents the Network File System (NFS) protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.
CfnLocationFSxOpenZFS.ProtocolProperty	Struct	Represents the protocol that AWS DataSync uses to access your Amazon FSx for OpenZFS file system.
CfnLocationFSxOpenZFSProps	Struct	Properties for defining a CfnLocationFSxOpenZFS.
CfnLocationFSxWindows.CmkSecretConfigProperty	Struct	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.
CfnLocationFSxWindows.CustomSecretConfigProperty	Struct	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.
CfnLocationFSxWindows.ManagedSecretConfigProperty	Struct	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.
CfnLocationFSxWindowsProps	Struct	Properties for defining a CfnLocationFSxWindows.
CfnLocationHDFS.CmkSecretConfigProperty	Struct	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.
CfnLocationHDFS.CustomSecretConfigProperty	Struct	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.
CfnLocationHDFS.ManagedSecretConfigProperty	Struct	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.
CfnLocationHDFS.NameNodeProperty	Struct	The NameNode of the Hadoop Distributed File System (HDFS).
CfnLocationHDFS.QopConfigurationProperty	Struct	The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
CfnLocationHDFSProps	Struct	Properties for defining a CfnLocationHDFS.
CfnLocationNFS.MountOptionsProperty	Struct	Specifies the options that DataSync can use to mount your NFS file server.
CfnLocationNFS.OnPremConfigProperty	Struct	The AWS DataSync agents that can connect to your Network File System (NFS) file server.
CfnLocationNFSProps	Struct	Properties for defining a CfnLocationNFS.
CfnLocationObjectStorage.CmkSecretConfigProperty	Struct	Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
CfnLocationObjectStorage.CustomSecretConfigProperty	Struct	Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).
CfnLocationObjectStorage.GoogleOidcConfigProperty	Struct	Specifies the Google Cloud workload identity federation configuration that DataSync uses to obtain an access token for your Google Cloud Storage bucket.
CfnLocationObjectStorage.ManagedSecretConfigProperty	Struct	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.
CfnLocationObjectStorage.ObjectStorageExternalIdentityConfigProperty	Struct	Specifies the external (non-AWS) identity provider that DataSync federates with to access your object storage location.
CfnLocationObjectStorage.ObjectStorageFederatedIdentityConfigProperty	Struct	Specifies the identity federation configuration that DataSync uses to access your object storage location using an OpenID Connect (OIDC) token.
CfnLocationObjectStorageProps	Struct	Properties for defining a CfnLocationObjectStorage.
CfnLocationS3.S3ConfigProperty	Struct	Specifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.
CfnLocationS3Props	Struct	Properties for defining a CfnLocationS3.
CfnLocationSMB.CmkSecretConfigProperty	Struct	Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key .
CfnLocationSMB.CustomSecretConfigProperty	Struct	Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab).
CfnLocationSMB.ManagedSecretConfigProperty	Struct	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.
CfnLocationSMB.MountOptionsProperty	Struct	Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
CfnLocationSMBProps	Struct	Properties for defining a CfnLocationSMB.
CfnTask.DeletedProperty	Struct	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location.
CfnTask.DestinationProperty	Struct	Specifies where DataSync uploads your task report.
CfnTask.FilterRuleProperty	Struct	Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
CfnTask.ManifestConfigProperty	Struct	Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer.
CfnTask.ManifestConfigSourceS3Property	Struct	Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.
CfnTask.OptionsProperty	Struct	Represents the options that are available to control the behavior of a StartTaskExecution operation. This behavior includes preserving metadata, such as user ID (UID), group ID (GID), and file permissions; overwriting files in the destination; data integrity verification; and so on.
CfnTask.OverridesProperty	Struct	Customizes the reporting level for aspects of your task report.
CfnTask.S3Property	Struct
CfnTask.SkippedProperty	Struct	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.
CfnTask.SourceProperty	Struct	Specifies the manifest that you want DataSync to use and where it's hosted.
CfnTask.TaskReportConfigProperty	Struct	Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer.
CfnTask.TaskScheduleProperty	Struct	Configures your AWS DataSync task to run on a schedule (at a minimum interval of 1 hour).
CfnTask.TransferredProperty	Struct	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.
CfnTask.VerifiedProperty	Struct	Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer.
CfnTaskProps	Struct	Properties for defining a CfnTask.