AWS SDK for C++  1.9.105
AWS SDK for C++
Public Member Functions | Public Attributes | List of all members
Aws::Transfer::TransferManagerConfiguration Struct Reference

#include <TransferManager.h>

Public Member Functions

 TransferManagerConfiguration (Aws::Utils::Threading::Executor *executor)
 

Public Attributes

std::shared_ptr< Aws::S3::S3Clients3Client
 
Aws::Utils::Threading::ExecutortransferExecutor
 
bool computeContentMD5
 
Aws::S3::Model::PutObjectRequest putObjectTemplate
 
Aws::S3::Model::GetObjectRequest getObjectTemplate
 
Aws::S3::Model::CreateMultipartUploadRequest createMultipartUploadTemplate
 
Aws::S3::Model::UploadPartRequest uploadPartTemplate
 
uint64_t transferBufferMaxHeapSize
 
uint64_t bufferSize
 
UploadProgressCallback uploadProgressCallback
 
DownloadProgressCallback downloadProgressCallback
 
TransferStatusUpdatedCallback transferStatusUpdatedCallback
 
TransferInitiatedCallback transferInitiatedCallback
 
ErrorCallback errorCallback
 
Aws::Map< Aws::String, Aws::StringcustomizedAccessLogTag
 

Detailed Description

Configuration for use with TransferManager. The data here will be copied directly to TransferManager.

Definition at line 38 of file TransferManager.h.

Constructor & Destructor Documentation

◆ TransferManagerConfiguration()

Aws::Transfer::TransferManagerConfiguration::TransferManagerConfiguration ( Aws::Utils::Threading::Executor executor)
inline

Definition at line 40 of file TransferManager.h.

Member Data Documentation

◆ bufferSize

uint64_t Aws::Transfer::TransferManagerConfiguration::bufferSize

Defaults to 5MB. If you are uploading large files, (larger than 50GB, this needs to be specified to be something larger than 5MB. Also keep in mind that you may need to increase your max heap size if this is something you plan on increasing.

Definition at line 90 of file TransferManager.h.

◆ computeContentMD5

bool Aws::Transfer::TransferManagerConfiguration::computeContentMD5

When true, TransferManager will calculate the MD5 digest of the content being uploaded. The digest is sent to S3 via an HTTP header enabling the service to perform integrity checks. This option is disabled by default.

Definition at line 59 of file TransferManager.h.

◆ createMultipartUploadTemplate

Aws::S3::Model::CreateMultipartUploadRequest Aws::Transfer::TransferManagerConfiguration::createMultipartUploadTemplate

If you have special arguments you want passed to our create multipart upload calls, put them here. We will copy the template for each call overriding the body stream, bucket, and key. If object metadata is passed through, we will override that as well.

Definition at line 74 of file TransferManager.h.

◆ customizedAccessLogTag

Aws::Map<Aws::String, Aws::String> Aws::Transfer::TransferManagerConfiguration::customizedAccessLogTag

To support Customer Access Log Information when access S3. https://docs.aws.amazon.com/AmazonS3/latest/dev/LogFormat.html Note: query string key not started with "x-" will be filtered out. key/val of map entries will be key/val of query strings.

Definition at line 118 of file TransferManager.h.

◆ downloadProgressCallback

DownloadProgressCallback Aws::Transfer::TransferManagerConfiguration::downloadProgressCallback

Callback to receive progress updates for downloads.

Definition at line 99 of file TransferManager.h.

◆ errorCallback

ErrorCallback Aws::Transfer::TransferManagerConfiguration::errorCallback

Callback to receive all errors that are thrown over the course of a transfer.

Definition at line 111 of file TransferManager.h.

◆ getObjectTemplate

Aws::S3::Model::GetObjectRequest Aws::Transfer::TransferManagerConfiguration::getObjectTemplate

If you have special arguments you want passed to our get object calls, put them here. We will copy the template for each put object call overriding the body stream, bucket, and key. If object metadata is passed through, we will override that as well.

Definition at line 69 of file TransferManager.h.

◆ putObjectTemplate

Aws::S3::Model::PutObjectRequest Aws::Transfer::TransferManagerConfiguration::putObjectTemplate

If you have special arguments you want passed to our put object calls, put them here. We will copy the template for each put object call overriding the body stream, bucket, and key. If object metadata is passed through, we will override that as well.

Definition at line 64 of file TransferManager.h.

◆ s3Client

std::shared_ptr<Aws::S3::S3Client> Aws::Transfer::TransferManagerConfiguration::s3Client

S3 Client to use for transfers. You are responsible for setting this.

Definition at line 47 of file TransferManager.h.

◆ transferBufferMaxHeapSize

uint64_t Aws::Transfer::TransferManagerConfiguration::transferBufferMaxHeapSize

Maximum size of the working buffers to use. This is not the same thing as max heap size for your process. This is the maximum amount of memory we will allocate for all transfer buffers. default is 50MB. If you are using Aws::Utils::Threading::PooledThreadExecutor for transferExecutor, this size should be greater than bufferSize * poolSize.

Definition at line 85 of file TransferManager.h.

◆ transferExecutor

Aws::Utils::Threading::Executor* Aws::Transfer::TransferManagerConfiguration::transferExecutor

Executor to use for the transfer manager threads. This probably shouldn't be the same executor you are using for your client configuration. This executor will be used in a different context than the s3 client is used. It is not a bug to use the same executor, but at least be aware that this is how the manager will be used.

Definition at line 53 of file TransferManager.h.

◆ transferInitiatedCallback

TransferInitiatedCallback Aws::Transfer::TransferManagerConfiguration::transferInitiatedCallback

Callback to receive initiated transfers for the directory operations.

Definition at line 107 of file TransferManager.h.

◆ transferStatusUpdatedCallback

TransferStatusUpdatedCallback Aws::Transfer::TransferManagerConfiguration::transferStatusUpdatedCallback

Callback to receive updates on the status of the transfer.

Definition at line 103 of file TransferManager.h.

◆ uploadPartTemplate

Aws::S3::Model::UploadPartRequest Aws::Transfer::TransferManagerConfiguration::uploadPartTemplate

If you have special arguments you want passed to our upload part calls, put them here. We will copy the template for each call overriding the body stream, bucket, and key. If object metadata is passed through, we will override that as well.

Definition at line 79 of file TransferManager.h.

◆ uploadProgressCallback

UploadProgressCallback Aws::Transfer::TransferManagerConfiguration::uploadProgressCallback

Callback to receive progress updates for uploads.

Definition at line 95 of file TransferManager.h.


The documentation for this struct was generated from the following file: