Interface IS3RepositorySettings

Snapshot repository settings for IS3Repository

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public interface IS3RepositorySettings : IRepositorySettings

Properties

BasePath

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

Declaration

[DataMember(Name = "base_path")]
string BasePath { get; set; }

Property Value

Type	Description
string

Bucket

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

Declaration

[DataMember(Name = "bucket")]
string Bucket { get; set; }

Property Value

Type	Description
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.

Declaration

[DataMember(Name = "buffer_size")]
string BufferSize { get; set; }

Property Value

Type	Description
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.

Declaration

[DataMember(Name = "canned_acl")]
string CannedAcl { get; set; }

Property Value

Type	Description
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.

Declaration

[DataMember(Name = "chunk_size")]
string ChunkSize { get; set; }

Property Value

Type	Description
string

Client

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

Declaration

[DataMember(Name = "client")]
string Client { get; set; }

Property Value

Type	Description
string

Compress

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.

Declaration

[DataMember(Name = "compress")]
bool? Compress { get; set; }

Property Value

Type	Description
bool?

DisableChunkedEncoding

Whether chunked encoding should be disabled or not. If false, chunked encoding is enabled and will be used where appropriate. If true, chunked encoding is disabled and will not be used, which may mean that snapshot operations consume more resources and take longer to complete. It should only be set to true if you are using a storage service that does not support chunked encoding. Defaults to false.

Declaration

[DataMember(Name = "disable_chunked_encoding")]
bool? DisableChunkedEncoding { get; set; }

Property Value

Type	Description
bool?

MaxRestoreBytesPerSecond

Throttles per node restore rate. Defaults to 40mb per second.

Declaration

[DataMember(Name = "max_restore_bytes_per_sec")]
string MaxRestoreBytesPerSecond { get; set; }

Property Value

Type	Description
string

MaxSnapshotBytesPerSecond

Throttles per node snapshot rate. Defaults to 40mb per second.

Declaration

[DataMember(Name = "max_snapshot_bytes_per_sec")]
string MaxSnapshotBytesPerSecond { get; set; }

Property Value

Type	Description
string

PathStyleAccess

Whether to force the use of the path style access pattern. If true, the path style access pattern will be used. If false, the access pattern will be automatically determined by the AWS Java SDK used internally by OpenSearch

Declaration

[DataMember(Name = "path_style_access")]
bool? PathStyleAccess { get; set; }

Property Value

Type	Description
bool?

ReadOnly

Make the repository readonly. Defaults to false.

Declaration

[DataMember(Name = "readonly")]
bool? ReadOnly { get; set; }

Property Value

Type	Description
bool?

ServerSideEncryption

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

Declaration

[DataMember(Name = "server_side_encryption")]
bool? ServerSideEncryption { get; set; }

Property Value

Type	Description
bool?

StorageClass

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

Declaration

[DataMember(Name = "storage_class")]
string StorageClass { get; set; }

Property Value

Type	Description
string

Extension Methods

SuffixExtensions.Suffix(object, string)