NEST by Elastic and contributors

<PackageReference Include="NEST" Version="6.8.10" />

.NET API 5,345,792 bytes

 S3RepositorySettingsDescriptor

public class S3RepositorySettingsDescriptor : DescriptorBase<S3RepositorySettingsDescriptor, IS3RepositorySettings>, IS3RepositorySettings, IRepositorySettings
public S3RepositorySettingsDescriptor()

public S3RepositorySettingsDescriptor(string bucket)

public S3RepositorySettingsDescriptor AccessKey(string accessKey)

public S3RepositorySettingsDescriptor BasePath(string basePath)

Specifies the path within bucket to repository data. Defaults to value of repositories.s3.base_path or to root directory if not set.

public S3RepositorySettingsDescriptor Bucket(string bucket)

The name of the bucket to be used for snapshots. This field is required

public S3RepositorySettingsDescriptor BufferSize(string bufferSize)

Minimum threshold below which the chunk is uploaded using a single request. Beyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of buffer_size length, and to upload each part in its own request. Note that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors. It is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3. Defaults to the minimum between 100mb and 5% of the heap size.

public S3RepositorySettingsDescriptor CannedAcl(string cannedAcl)

Specify a canned ACL for the S3 bucket. The S3 repository supports all S3 canned ACLs : private, public-read, public-read-write, authenticated-read, log-delivery-write, bucket-owner-read, bucket-owner-full-control. Defaults to private.

public S3RepositorySettingsDescriptor ChunkSize(string chunkSize)

Big files can be broken down into chunks during snapshotting if needed. The chunk size can be specified in bytes or by using size value notation, i.e. 1gb, 10mb, 5kb. Defaults to 1gb.

public S3RepositorySettingsDescriptor Client(string client)

The name of the s3 client to use to connect to S3. Defaults to default.

public S3RepositorySettingsDescriptor Compress(bool? compress = true)

When set to true metadata files are stored in compressed format. This setting doesn't affect index files that are already compressed by default. Defaults to false.

public S3RepositorySettingsDescriptor ConcurrentStreams(int? concurrentStreams)

public S3RepositorySettingsDescriptor SecretKey(string secretKey)

public S3RepositorySettingsDescriptor ServerSideEncryption(bool? serverSideEncryption = true)

When set to true files are encrypted on server side using AES256 algorithm. Defaults to false.

public S3RepositorySettingsDescriptor StorageClass(string storageClass)

Sets the S3 storage class type for the backup files. Values may be standard, reduced_redundancy, standard_ia. Defaults to standard.