Package-level declarations

Types

Link copied to clipboard
data class GetAgentResult(val agentArn: String? = null, val agentName: String? = null, val endpointType: AgentEndpointType? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationAzureBlobResult(val agentArns: List<String>? = null, val azureAccessTier: LocationAzureBlobAzureAccessTier? = null, val azureBlobAuthenticationType: LocationAzureBlobAzureBlobAuthenticationType? = null, val azureBlobType: LocationAzureBlobAzureBlobType? = null, val locationArn: String? = null, val locationUri: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationEfsResult(val locationArn: String? = null, val locationUri: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationFSxLustreResult(val locationArn: String? = null, val locationUri: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationFSxOntapResult(val fsxFilesystemArn: String? = null, val locationArn: String? = null, val locationUri: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationFSxOpenZfsResult(val locationArn: String? = null, val locationUri: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationFSxWindowsResult(val locationArn: String? = null, val locationUri: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationHdfsResult(val agentArns: List<String>? = null, val authenticationType: LocationHdfsAuthenticationType? = null, val blockSize: Int? = null, val kerberosPrincipal: String? = null, val kmsKeyProviderUri: String? = null, val locationArn: String? = null, val locationUri: String? = null, val nameNodes: List<LocationHdfsNameNode>? = null, val qopConfiguration: LocationHdfsQopConfiguration? = null, val replicationFactor: Int? = null, val simpleUser: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationNfsResult(val locationArn: String? = null, val locationUri: String? = null, val mountOptions: LocationNfsMountOptions? = null, val onPremConfig: LocationNfsOnPremConfig? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationObjectStorageResult(val accessKey: String? = null, val agentArns: List<String>? = null, val locationArn: String? = null, val locationUri: String? = null, val serverCertificate: String? = null, val serverPort: Int? = null, val serverProtocol: LocationObjectStorageServerProtocol? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationS3Result(val locationArn: String? = null, val locationUri: String? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetLocationSmbResult(val agentArns: List<String>? = null, val domain: String? = null, val locationArn: String? = null, val locationUri: String? = null, val mountOptions: LocationSmbMountOptions? = null, val tags: List<Tag>? = null, val user: String? = null)
Link copied to clipboard
data class GetStorageSystemResult(val agentArns: List<String>? = null, val cloudWatchLogGroupArn: String? = null, val connectivityStatus: StorageSystemConnectivityStatus? = null, val name: String? = null, val secretsManagerArn: String? = null, val serverConfiguration: StorageSystemServerConfiguration? = null, val storageSystemArn: String? = null, val systemType: StorageSystemSystemType? = null, val tags: List<Tag>? = null)
Link copied to clipboard
data class GetTaskResult(val cloudWatchLogGroupArn: String? = null, val destinationNetworkInterfaceArns: List<String>? = null, val excludes: List<TaskFilterRule>? = null, val includes: List<TaskFilterRule>? = null, val manifestConfig: TaskManifestConfig? = null, val name: String? = null, val options: TaskOptions? = null, val schedule: TaskSchedule? = null, val sourceNetworkInterfaceArns: List<String>? = null, val status: TaskStatus? = null, val tags: List<Tag>? = null, val taskArn: String? = null, val taskReportConfig: TaskReportConfig? = null)
data class LocationAzureBlobAzureBlobSasConfiguration(val azureBlobSasToken: String)

Specifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container.

Link copied to clipboard
data class LocationEfsEc2Config(val securityGroupArns: List<String>, val subnetArn: String)

The subnet and security group that DataSync uses to access target EFS file system.

Link copied to clipboard

NFS protocol configuration for FSx ONTAP file system.

Link copied to clipboard

The NFS mount options that DataSync can use to mount your NFS share.

Link copied to clipboard
data class LocationFSxOntapProtocol(val nfs: LocationFSxOntapNfs? = null, val smb: LocationFSxOntapSmb? = null)

Configuration settings for NFS or SMB protocol.

Link copied to clipboard
data class LocationFSxOntapSmb(val domain: String? = null, val mountOptions: LocationFSxOntapSmbMountOptions, val password: String, val user: String)

SMB protocol configuration for FSx ONTAP file system.

Link copied to clipboard

The mount options used by DataSync to access the SMB server.

Link copied to clipboard

The NFS mount options that DataSync can use to mount your NFS share.

Link copied to clipboard

FSx OpenZFS file system NFS protocol information

Link copied to clipboard

Configuration settings for an NFS or SMB protocol, currently only support NFS

Link copied to clipboard
data class LocationHdfsNameNode(val hostname: String, val port: Int)

HDFS Name Node IP and port information.

Link copied to clipboard

Configuration information for RPC Protection and Data Transfer Protection. These parameters can be set to AUTHENTICATION, INTEGRITY, or PRIVACY. The default value is PRIVACY.

Link copied to clipboard

The NFS mount options that DataSync can use to mount your NFS share.

Link copied to clipboard
data class LocationNfsOnPremConfig(val agentArns: List<String>)

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.

Link copied to clipboard
data class LocationS3s3Config(val bucketAccessRoleArn: String)

The Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.

Link copied to clipboard

The mount options used by DataSync to access the SMB server.

Link copied to clipboard
data class StorageSystemServerConfiguration(val serverHostname: String, val serverPort: Int? = null)

The server name and network port required to connect with the management interface of the on-premises storage system.

Link copied to clipboard
data class StorageSystemServerCredentials(val password: String, val username: String)

The username and password for accessing your on-premises storage system's management interface.

Link copied to clipboard
data class TaskFilterRule(val filterType: TaskFilterRuleFilterType? = null, val value: String? = null)

Specifies which files folders and objects to include or exclude when transferring files from source to destination.

Link copied to clipboard
data class TaskManifestConfig(val action: TaskManifestConfigAction? = null, val format: TaskManifestConfigFormat? = null, val source: TaskManifestConfigSourceProperties)

Configures a manifest, which is a list of files or objects that you want DataSync to transfer.

Link copied to clipboard

Specifies the manifest that you want DataSync to use and where it's hosted.

Link copied to clipboard
data class TaskManifestConfigSourceS3(val bucketAccessRoleArn: String? = null, val manifestObjectPath: String? = null, val manifestObjectVersionId: String? = null, val s3BucketArn: String? = null)

Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use.

Link copied to clipboard
data class TaskOptions(val atime: TaskOptionsAtime? = null, val bytesPerSecond: Int? = null, val gid: TaskOptionsGid? = null, val logLevel: TaskOptionsLogLevel? = null, val mtime: TaskOptionsMtime? = null, val objectTags: TaskOptionsObjectTags? = null, val overwriteMode: TaskOptionsOverwriteMode? = null, val posixPermissions: TaskOptionsPosixPermissions? = null, val preserveDeletedFiles: TaskOptionsPreserveDeletedFiles? = null, val preserveDevices: TaskOptionsPreserveDevices? = null, val securityDescriptorCopyFlags: TaskOptionsSecurityDescriptorCopyFlags? = null, val taskQueueing: TaskOptionsTaskQueueing? = null, val transferMode: TaskOptionsTransferMode? = null, val uid: TaskOptionsUid? = null, val verifyMode: TaskOptionsVerifyMode? = null)

Represents the options that are available to control the behavior of a StartTaskExecution operation.

Link copied to clipboard
data class TaskReportConfig(val destination: TaskReportConfigDestinationProperties, val objectVersionIds: TaskReportConfigObjectVersionIds? = null, val outputType: TaskReportConfigOutputType, val overrides: TaskReportConfigOverridesProperties? = null, val reportLevel: TaskReportConfigReportLevel? = null)

Specifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.

Link copied to clipboard

Specifies where DataSync uploads your task report.

Link copied to clipboard
data class TaskReportConfigDestinationS3(val bucketAccessRoleArn: String? = null, val s3BucketArn: String? = null, val subdirectory: String? = null)

Specifies the Amazon S3 bucket where DataSync uploads your task report.

Link copied to clipboard

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that Datasync attempted to delete in your destination location.

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to skip during your transfer.

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to transfer.

Specifies the level of reporting for the files, objects, and directories that Datasync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which Datasync does by default)

Link copied to clipboard
data class TaskSchedule(val scheduleExpression: String? = null, val status: TaskScheduleStatus? = null)

Specifies the schedule you want your task to use for repeated executions.