elasticstack.ElasticsearchSnapshotRepository
Explore with Pulumi AI
Registers or updates a snapshot repository. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/put-snapshot-repo-api.html and https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const myUrlRepo = new elasticstack.ElasticsearchSnapshotRepository("myUrlRepo", {url: {
url: "https://example.com/repo",
}});
const myFsRepo = new elasticstack.ElasticsearchSnapshotRepository("myFsRepo", {fs: {
compress: true,
location: "/tmp",
maxRestoreBytesPerSec: "10mb",
}});
import pulumi
import pulumi_elasticstack as elasticstack
my_url_repo = elasticstack.ElasticsearchSnapshotRepository("myUrlRepo", url={
"url": "https://example.com/repo",
})
my_fs_repo = elasticstack.ElasticsearchSnapshotRepository("myFsRepo", fs={
"compress": True,
"location": "/tmp",
"max_restore_bytes_per_sec": "10mb",
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := elasticstack.NewElasticsearchSnapshotRepository(ctx, "myUrlRepo", &elasticstack.ElasticsearchSnapshotRepositoryArgs{
Url: &elasticstack.ElasticsearchSnapshotRepositoryUrlArgs{
Url: pulumi.String("https://example.com/repo"),
},
})
if err != nil {
return err
}
_, err = elasticstack.NewElasticsearchSnapshotRepository(ctx, "myFsRepo", &elasticstack.ElasticsearchSnapshotRepositoryArgs{
Fs: &elasticstack.ElasticsearchSnapshotRepositoryFsArgs{
Compress: pulumi.Bool(true),
Location: pulumi.String("/tmp"),
MaxRestoreBytesPerSec: pulumi.String("10mb"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;
return await Deployment.RunAsync(() =>
{
var myUrlRepo = new Elasticstack.ElasticsearchSnapshotRepository("myUrlRepo", new()
{
Url = new Elasticstack.Inputs.ElasticsearchSnapshotRepositoryUrlArgs
{
Url = "https://example.com/repo",
},
});
var myFsRepo = new Elasticstack.ElasticsearchSnapshotRepository("myFsRepo", new()
{
Fs = new Elasticstack.Inputs.ElasticsearchSnapshotRepositoryFsArgs
{
Compress = true,
Location = "/tmp",
MaxRestoreBytesPerSec = "10mb",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchSnapshotRepository;
import com.pulumi.elasticstack.ElasticsearchSnapshotRepositoryArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchSnapshotRepositoryUrlArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchSnapshotRepositoryFsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myUrlRepo = new ElasticsearchSnapshotRepository("myUrlRepo", ElasticsearchSnapshotRepositoryArgs.builder()
.url(ElasticsearchSnapshotRepositoryUrlArgs.builder()
.url("https://example.com/repo")
.build())
.build());
var myFsRepo = new ElasticsearchSnapshotRepository("myFsRepo", ElasticsearchSnapshotRepositoryArgs.builder()
.fs(ElasticsearchSnapshotRepositoryFsArgs.builder()
.compress(true)
.location("/tmp")
.maxRestoreBytesPerSec("10mb")
.build())
.build());
}
}
resources:
myUrlRepo:
type: elasticstack:ElasticsearchSnapshotRepository
properties:
url:
url: https://example.com/repo
myFsRepo:
type: elasticstack:ElasticsearchSnapshotRepository
properties:
fs:
compress: true
location: /tmp
maxRestoreBytesPerSec: 10mb
Create ElasticsearchSnapshotRepository Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ElasticsearchSnapshotRepository(name: string, args?: ElasticsearchSnapshotRepositoryArgs, opts?: CustomResourceOptions);
@overload
def ElasticsearchSnapshotRepository(resource_name: str,
args: Optional[ElasticsearchSnapshotRepositoryArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ElasticsearchSnapshotRepository(resource_name: str,
opts: Optional[ResourceOptions] = None,
azure: Optional[ElasticsearchSnapshotRepositoryAzureArgs] = None,
elasticsearch_connection: Optional[ElasticsearchSnapshotRepositoryElasticsearchConnectionArgs] = None,
fs: Optional[ElasticsearchSnapshotRepositoryFsArgs] = None,
gcs: Optional[ElasticsearchSnapshotRepositoryGcsArgs] = None,
hdfs: Optional[ElasticsearchSnapshotRepositoryHdfsArgs] = None,
name: Optional[str] = None,
s3: Optional[ElasticsearchSnapshotRepositoryS3Args] = None,
url: Optional[ElasticsearchSnapshotRepositoryUrlArgs] = None,
verify: Optional[bool] = None)
func NewElasticsearchSnapshotRepository(ctx *Context, name string, args *ElasticsearchSnapshotRepositoryArgs, opts ...ResourceOption) (*ElasticsearchSnapshotRepository, error)
public ElasticsearchSnapshotRepository(string name, ElasticsearchSnapshotRepositoryArgs? args = null, CustomResourceOptions? opts = null)
public ElasticsearchSnapshotRepository(String name, ElasticsearchSnapshotRepositoryArgs args)
public ElasticsearchSnapshotRepository(String name, ElasticsearchSnapshotRepositoryArgs args, CustomResourceOptions options)
type: elasticstack:ElasticsearchSnapshotRepository
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ElasticsearchSnapshotRepositoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ElasticsearchSnapshotRepositoryArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ElasticsearchSnapshotRepositoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ElasticsearchSnapshotRepositoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ElasticsearchSnapshotRepositoryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var elasticsearchSnapshotRepositoryResource = new Elasticstack.ElasticsearchSnapshotRepository("elasticsearchSnapshotRepositoryResource", new()
{
Azure = new Elasticstack.Inputs.ElasticsearchSnapshotRepositoryAzureArgs
{
Container = "string",
BasePath = "string",
ChunkSize = "string",
Client = "string",
Compress = false,
LocationMode = "string",
MaxRestoreBytesPerSec = "string",
MaxSnapshotBytesPerSec = "string",
Readonly = false,
},
Fs = new Elasticstack.Inputs.ElasticsearchSnapshotRepositoryFsArgs
{
Location = "string",
ChunkSize = "string",
Compress = false,
MaxNumberOfSnapshots = 0,
MaxRestoreBytesPerSec = "string",
MaxSnapshotBytesPerSec = "string",
Readonly = false,
},
Gcs = new Elasticstack.Inputs.ElasticsearchSnapshotRepositoryGcsArgs
{
Bucket = "string",
BasePath = "string",
ChunkSize = "string",
Client = "string",
Compress = false,
MaxRestoreBytesPerSec = "string",
MaxSnapshotBytesPerSec = "string",
Readonly = false,
},
Hdfs = new Elasticstack.Inputs.ElasticsearchSnapshotRepositoryHdfsArgs
{
Path = "string",
Uri = "string",
ChunkSize = "string",
Compress = false,
LoadDefaults = false,
MaxRestoreBytesPerSec = "string",
MaxSnapshotBytesPerSec = "string",
Readonly = false,
},
Name = "string",
S3 = new Elasticstack.Inputs.ElasticsearchSnapshotRepositoryS3Args
{
Bucket = "string",
Compress = false,
BufferSize = "string",
CannedAcl = "string",
ChunkSize = "string",
Client = "string",
BasePath = "string",
MaxRestoreBytesPerSec = "string",
MaxSnapshotBytesPerSec = "string",
PathStyleAccess = false,
Readonly = false,
ServerSideEncryption = false,
StorageClass = "string",
},
Url = new Elasticstack.Inputs.ElasticsearchSnapshotRepositoryUrlArgs
{
Url = "string",
ChunkSize = "string",
Compress = false,
HttpMaxRetries = 0,
HttpSocketTimeout = "string",
MaxNumberOfSnapshots = 0,
MaxRestoreBytesPerSec = "string",
MaxSnapshotBytesPerSec = "string",
Readonly = false,
},
Verify = false,
});
example, err := elasticstack.NewElasticsearchSnapshotRepository(ctx, "elasticsearchSnapshotRepositoryResource", &elasticstack.ElasticsearchSnapshotRepositoryArgs{
Azure: &elasticstack.ElasticsearchSnapshotRepositoryAzureArgs{
Container: pulumi.String("string"),
BasePath: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
Client: pulumi.String("string"),
Compress: pulumi.Bool(false),
LocationMode: pulumi.String("string"),
MaxRestoreBytesPerSec: pulumi.String("string"),
MaxSnapshotBytesPerSec: pulumi.String("string"),
Readonly: pulumi.Bool(false),
},
Fs: &elasticstack.ElasticsearchSnapshotRepositoryFsArgs{
Location: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
Compress: pulumi.Bool(false),
MaxNumberOfSnapshots: pulumi.Float64(0),
MaxRestoreBytesPerSec: pulumi.String("string"),
MaxSnapshotBytesPerSec: pulumi.String("string"),
Readonly: pulumi.Bool(false),
},
Gcs: &elasticstack.ElasticsearchSnapshotRepositoryGcsArgs{
Bucket: pulumi.String("string"),
BasePath: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
Client: pulumi.String("string"),
Compress: pulumi.Bool(false),
MaxRestoreBytesPerSec: pulumi.String("string"),
MaxSnapshotBytesPerSec: pulumi.String("string"),
Readonly: pulumi.Bool(false),
},
Hdfs: &elasticstack.ElasticsearchSnapshotRepositoryHdfsArgs{
Path: pulumi.String("string"),
Uri: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
Compress: pulumi.Bool(false),
LoadDefaults: pulumi.Bool(false),
MaxRestoreBytesPerSec: pulumi.String("string"),
MaxSnapshotBytesPerSec: pulumi.String("string"),
Readonly: pulumi.Bool(false),
},
Name: pulumi.String("string"),
S3: &elasticstack.ElasticsearchSnapshotRepositoryS3Args{
Bucket: pulumi.String("string"),
Compress: pulumi.Bool(false),
BufferSize: pulumi.String("string"),
CannedAcl: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
Client: pulumi.String("string"),
BasePath: pulumi.String("string"),
MaxRestoreBytesPerSec: pulumi.String("string"),
MaxSnapshotBytesPerSec: pulumi.String("string"),
PathStyleAccess: pulumi.Bool(false),
Readonly: pulumi.Bool(false),
ServerSideEncryption: pulumi.Bool(false),
StorageClass: pulumi.String("string"),
},
Url: &elasticstack.ElasticsearchSnapshotRepositoryUrlArgs{
Url: pulumi.String("string"),
ChunkSize: pulumi.String("string"),
Compress: pulumi.Bool(false),
HttpMaxRetries: pulumi.Float64(0),
HttpSocketTimeout: pulumi.String("string"),
MaxNumberOfSnapshots: pulumi.Float64(0),
MaxRestoreBytesPerSec: pulumi.String("string"),
MaxSnapshotBytesPerSec: pulumi.String("string"),
Readonly: pulumi.Bool(false),
},
Verify: pulumi.Bool(false),
})
var elasticsearchSnapshotRepositoryResource = new ElasticsearchSnapshotRepository("elasticsearchSnapshotRepositoryResource", ElasticsearchSnapshotRepositoryArgs.builder()
.azure(ElasticsearchSnapshotRepositoryAzureArgs.builder()
.container("string")
.basePath("string")
.chunkSize("string")
.client("string")
.compress(false)
.locationMode("string")
.maxRestoreBytesPerSec("string")
.maxSnapshotBytesPerSec("string")
.readonly(false)
.build())
.fs(ElasticsearchSnapshotRepositoryFsArgs.builder()
.location("string")
.chunkSize("string")
.compress(false)
.maxNumberOfSnapshots(0)
.maxRestoreBytesPerSec("string")
.maxSnapshotBytesPerSec("string")
.readonly(false)
.build())
.gcs(ElasticsearchSnapshotRepositoryGcsArgs.builder()
.bucket("string")
.basePath("string")
.chunkSize("string")
.client("string")
.compress(false)
.maxRestoreBytesPerSec("string")
.maxSnapshotBytesPerSec("string")
.readonly(false)
.build())
.hdfs(ElasticsearchSnapshotRepositoryHdfsArgs.builder()
.path("string")
.uri("string")
.chunkSize("string")
.compress(false)
.loadDefaults(false)
.maxRestoreBytesPerSec("string")
.maxSnapshotBytesPerSec("string")
.readonly(false)
.build())
.name("string")
.s3(ElasticsearchSnapshotRepositoryS3Args.builder()
.bucket("string")
.compress(false)
.bufferSize("string")
.cannedAcl("string")
.chunkSize("string")
.client("string")
.basePath("string")
.maxRestoreBytesPerSec("string")
.maxSnapshotBytesPerSec("string")
.pathStyleAccess(false)
.readonly(false)
.serverSideEncryption(false)
.storageClass("string")
.build())
.url(ElasticsearchSnapshotRepositoryUrlArgs.builder()
.url("string")
.chunkSize("string")
.compress(false)
.httpMaxRetries(0)
.httpSocketTimeout("string")
.maxNumberOfSnapshots(0)
.maxRestoreBytesPerSec("string")
.maxSnapshotBytesPerSec("string")
.readonly(false)
.build())
.verify(false)
.build());
elasticsearch_snapshot_repository_resource = elasticstack.ElasticsearchSnapshotRepository("elasticsearchSnapshotRepositoryResource",
azure={
"container": "string",
"base_path": "string",
"chunk_size": "string",
"client": "string",
"compress": False,
"location_mode": "string",
"max_restore_bytes_per_sec": "string",
"max_snapshot_bytes_per_sec": "string",
"readonly": False,
},
fs={
"location": "string",
"chunk_size": "string",
"compress": False,
"max_number_of_snapshots": 0,
"max_restore_bytes_per_sec": "string",
"max_snapshot_bytes_per_sec": "string",
"readonly": False,
},
gcs={
"bucket": "string",
"base_path": "string",
"chunk_size": "string",
"client": "string",
"compress": False,
"max_restore_bytes_per_sec": "string",
"max_snapshot_bytes_per_sec": "string",
"readonly": False,
},
hdfs={
"path": "string",
"uri": "string",
"chunk_size": "string",
"compress": False,
"load_defaults": False,
"max_restore_bytes_per_sec": "string",
"max_snapshot_bytes_per_sec": "string",
"readonly": False,
},
name="string",
s3={
"bucket": "string",
"compress": False,
"buffer_size": "string",
"canned_acl": "string",
"chunk_size": "string",
"client": "string",
"base_path": "string",
"max_restore_bytes_per_sec": "string",
"max_snapshot_bytes_per_sec": "string",
"path_style_access": False,
"readonly": False,
"server_side_encryption": False,
"storage_class": "string",
},
url={
"url": "string",
"chunk_size": "string",
"compress": False,
"http_max_retries": 0,
"http_socket_timeout": "string",
"max_number_of_snapshots": 0,
"max_restore_bytes_per_sec": "string",
"max_snapshot_bytes_per_sec": "string",
"readonly": False,
},
verify=False)
const elasticsearchSnapshotRepositoryResource = new elasticstack.ElasticsearchSnapshotRepository("elasticsearchSnapshotRepositoryResource", {
azure: {
container: "string",
basePath: "string",
chunkSize: "string",
client: "string",
compress: false,
locationMode: "string",
maxRestoreBytesPerSec: "string",
maxSnapshotBytesPerSec: "string",
readonly: false,
},
fs: {
location: "string",
chunkSize: "string",
compress: false,
maxNumberOfSnapshots: 0,
maxRestoreBytesPerSec: "string",
maxSnapshotBytesPerSec: "string",
readonly: false,
},
gcs: {
bucket: "string",
basePath: "string",
chunkSize: "string",
client: "string",
compress: false,
maxRestoreBytesPerSec: "string",
maxSnapshotBytesPerSec: "string",
readonly: false,
},
hdfs: {
path: "string",
uri: "string",
chunkSize: "string",
compress: false,
loadDefaults: false,
maxRestoreBytesPerSec: "string",
maxSnapshotBytesPerSec: "string",
readonly: false,
},
name: "string",
s3: {
bucket: "string",
compress: false,
bufferSize: "string",
cannedAcl: "string",
chunkSize: "string",
client: "string",
basePath: "string",
maxRestoreBytesPerSec: "string",
maxSnapshotBytesPerSec: "string",
pathStyleAccess: false,
readonly: false,
serverSideEncryption: false,
storageClass: "string",
},
url: {
url: "string",
chunkSize: "string",
compress: false,
httpMaxRetries: 0,
httpSocketTimeout: "string",
maxNumberOfSnapshots: 0,
maxRestoreBytesPerSec: "string",
maxSnapshotBytesPerSec: "string",
readonly: false,
},
verify: false,
});
type: elasticstack:ElasticsearchSnapshotRepository
properties:
azure:
basePath: string
chunkSize: string
client: string
compress: false
container: string
locationMode: string
maxRestoreBytesPerSec: string
maxSnapshotBytesPerSec: string
readonly: false
fs:
chunkSize: string
compress: false
location: string
maxNumberOfSnapshots: 0
maxRestoreBytesPerSec: string
maxSnapshotBytesPerSec: string
readonly: false
gcs:
basePath: string
bucket: string
chunkSize: string
client: string
compress: false
maxRestoreBytesPerSec: string
maxSnapshotBytesPerSec: string
readonly: false
hdfs:
chunkSize: string
compress: false
loadDefaults: false
maxRestoreBytesPerSec: string
maxSnapshotBytesPerSec: string
path: string
readonly: false
uri: string
name: string
s3:
basePath: string
bucket: string
bufferSize: string
cannedAcl: string
chunkSize: string
client: string
compress: false
maxRestoreBytesPerSec: string
maxSnapshotBytesPerSec: string
pathStyleAccess: false
readonly: false
serverSideEncryption: false
storageClass: string
url:
chunkSize: string
compress: false
httpMaxRetries: 0
httpSocketTimeout: string
maxNumberOfSnapshots: 0
maxRestoreBytesPerSec: string
maxSnapshotBytesPerSec: string
readonly: false
url: string
verify: false
ElasticsearchSnapshotRepository Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ElasticsearchSnapshotRepository resource accepts the following input properties:
- Azure
Elasticsearch
Snapshot Repository Azure - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- Elasticsearch
Connection ElasticsearchSnapshot Repository Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- Fs
Elasticsearch
Snapshot Repository Fs - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- Gcs
Elasticsearch
Snapshot Repository Gcs - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- Hdfs
Elasticsearch
Snapshot Repository Hdfs - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- Name string
- Name of the snapshot repository to register or update.
- S3
Elasticsearch
Snapshot Repository S3 - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- Url
Elasticsearch
Snapshot Repository Url - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- Verify bool
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- Azure
Elasticsearch
Snapshot Repository Azure Args - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- Elasticsearch
Connection ElasticsearchSnapshot Repository Elasticsearch Connection Args - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- Fs
Elasticsearch
Snapshot Repository Fs Args - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- Gcs
Elasticsearch
Snapshot Repository Gcs Args - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- Hdfs
Elasticsearch
Snapshot Repository Hdfs Args - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- Name string
- Name of the snapshot repository to register or update.
- S3
Elasticsearch
Snapshot Repository S3Args - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- Url
Elasticsearch
Snapshot Repository Url Args - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- Verify bool
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- azure
Elasticsearch
Snapshot Repository Azure - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- elasticsearch
Connection ElasticsearchSnapshot Repository Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- fs
Elasticsearch
Snapshot Repository Fs - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- gcs
Elasticsearch
Snapshot Repository Gcs - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- hdfs
Elasticsearch
Snapshot Repository Hdfs - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- name String
- Name of the snapshot repository to register or update.
- s3
Elasticsearch
Snapshot Repository S3 - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- url
Elasticsearch
Snapshot Repository Url - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- verify Boolean
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- azure
Elasticsearch
Snapshot Repository Azure - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- elasticsearch
Connection ElasticsearchSnapshot Repository Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- fs
Elasticsearch
Snapshot Repository Fs - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- gcs
Elasticsearch
Snapshot Repository Gcs - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- hdfs
Elasticsearch
Snapshot Repository Hdfs - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- name string
- Name of the snapshot repository to register or update.
- s3
Elasticsearch
Snapshot Repository S3 - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- url
Elasticsearch
Snapshot Repository Url - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- verify boolean
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- azure
Elasticsearch
Snapshot Repository Azure Args - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- elasticsearch_
connection ElasticsearchSnapshot Repository Elasticsearch Connection Args - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- fs
Elasticsearch
Snapshot Repository Fs Args - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- gcs
Elasticsearch
Snapshot Repository Gcs Args - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- hdfs
Elasticsearch
Snapshot Repository Hdfs Args - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- name str
- Name of the snapshot repository to register or update.
- s3
Elasticsearch
Snapshot Repository S3Args - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- url
Elasticsearch
Snapshot Repository Url Args - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- verify bool
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- azure Property Map
- Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- elasticsearch
Connection Property Map - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- fs Property Map
- Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- gcs Property Map
- Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- hdfs Property Map
- Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- name String
- Name of the snapshot repository to register or update.
- s3 Property Map
- Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- url Property Map
- URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- verify Boolean
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
Outputs
All input properties are implicitly available as output properties. Additionally, the ElasticsearchSnapshotRepository resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ElasticsearchSnapshotRepository Resource
Get an existing ElasticsearchSnapshotRepository resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ElasticsearchSnapshotRepositoryState, opts?: CustomResourceOptions): ElasticsearchSnapshotRepository
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
azure: Optional[ElasticsearchSnapshotRepositoryAzureArgs] = None,
elasticsearch_connection: Optional[ElasticsearchSnapshotRepositoryElasticsearchConnectionArgs] = None,
fs: Optional[ElasticsearchSnapshotRepositoryFsArgs] = None,
gcs: Optional[ElasticsearchSnapshotRepositoryGcsArgs] = None,
hdfs: Optional[ElasticsearchSnapshotRepositoryHdfsArgs] = None,
name: Optional[str] = None,
s3: Optional[ElasticsearchSnapshotRepositoryS3Args] = None,
url: Optional[ElasticsearchSnapshotRepositoryUrlArgs] = None,
verify: Optional[bool] = None) -> ElasticsearchSnapshotRepository
func GetElasticsearchSnapshotRepository(ctx *Context, name string, id IDInput, state *ElasticsearchSnapshotRepositoryState, opts ...ResourceOption) (*ElasticsearchSnapshotRepository, error)
public static ElasticsearchSnapshotRepository Get(string name, Input<string> id, ElasticsearchSnapshotRepositoryState? state, CustomResourceOptions? opts = null)
public static ElasticsearchSnapshotRepository get(String name, Output<String> id, ElasticsearchSnapshotRepositoryState state, CustomResourceOptions options)
resources: _: type: elasticstack:ElasticsearchSnapshotRepository get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Azure
Elasticsearch
Snapshot Repository Azure - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- Elasticsearch
Connection ElasticsearchSnapshot Repository Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- Fs
Elasticsearch
Snapshot Repository Fs - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- Gcs
Elasticsearch
Snapshot Repository Gcs - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- Hdfs
Elasticsearch
Snapshot Repository Hdfs - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- Name string
- Name of the snapshot repository to register or update.
- S3
Elasticsearch
Snapshot Repository S3 - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- Url
Elasticsearch
Snapshot Repository Url - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- Verify bool
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- Azure
Elasticsearch
Snapshot Repository Azure Args - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- Elasticsearch
Connection ElasticsearchSnapshot Repository Elasticsearch Connection Args - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- Fs
Elasticsearch
Snapshot Repository Fs Args - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- Gcs
Elasticsearch
Snapshot Repository Gcs Args - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- Hdfs
Elasticsearch
Snapshot Repository Hdfs Args - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- Name string
- Name of the snapshot repository to register or update.
- S3
Elasticsearch
Snapshot Repository S3Args - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- Url
Elasticsearch
Snapshot Repository Url Args - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- Verify bool
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- azure
Elasticsearch
Snapshot Repository Azure - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- elasticsearch
Connection ElasticsearchSnapshot Repository Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- fs
Elasticsearch
Snapshot Repository Fs - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- gcs
Elasticsearch
Snapshot Repository Gcs - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- hdfs
Elasticsearch
Snapshot Repository Hdfs - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- name String
- Name of the snapshot repository to register or update.
- s3
Elasticsearch
Snapshot Repository S3 - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- url
Elasticsearch
Snapshot Repository Url - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- verify Boolean
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- azure
Elasticsearch
Snapshot Repository Azure - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- elasticsearch
Connection ElasticsearchSnapshot Repository Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- fs
Elasticsearch
Snapshot Repository Fs - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- gcs
Elasticsearch
Snapshot Repository Gcs - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- hdfs
Elasticsearch
Snapshot Repository Hdfs - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- name string
- Name of the snapshot repository to register or update.
- s3
Elasticsearch
Snapshot Repository S3 - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- url
Elasticsearch
Snapshot Repository Url - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- verify boolean
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- azure
Elasticsearch
Snapshot Repository Azure Args - Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- elasticsearch_
connection ElasticsearchSnapshot Repository Elasticsearch Connection Args - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- fs
Elasticsearch
Snapshot Repository Fs Args - Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- gcs
Elasticsearch
Snapshot Repository Gcs Args - Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- hdfs
Elasticsearch
Snapshot Repository Hdfs Args - Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- name str
- Name of the snapshot repository to register or update.
- s3
Elasticsearch
Snapshot Repository S3Args - Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- url
Elasticsearch
Snapshot Repository Url Args - URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- verify bool
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
- azure Property Map
- Support for using Azure Blob storage as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-azure.html
- elasticsearch
Connection Property Map - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- fs Property Map
- Shared filesystem repository. Repositories of this type use a shared filesystem to store snapshots. This filesystem must be accessible to all master and data nodes in the cluster.
- gcs Property Map
- Support for using the Google Cloud Storage service as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-gcs.html
- hdfs Property Map
- Support for using HDFS File System as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-hdfs.html
- name String
- Name of the snapshot repository to register or update.
- s3 Property Map
- Support for using AWS S3 as a repository for Snapshot/Restore. See: https://www.elastic.co/guide/en/elasticsearch/plugins/current/repository-s3-repository.html
- url Property Map
- URL repository. Repositories of this type are read-only for the cluster. This means the cluster can retrieve or restore snapshots from the repository but cannot write or create snapshots in it.
- verify Boolean
- If true, the request verifies the repository is functional on all master and data nodes in the cluster.
Supporting Types
ElasticsearchSnapshotRepositoryAzure, ElasticsearchSnapshotRepositoryAzureArgs
- Container string
- Container name. You must create the Azure container before creating the repository.
- Base
Path string - Specifies the path within the container to the repository data.
- Chunk
Size string - Maximum size of files in snapshots.
- Client string
- Azure named client to use.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Location
Mode string - Location mode.
primary_only
orsecondary_only
. See: https://docs.microsoft.com/en-us/azure/storage/common/storage-redundancy - Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- Container string
- Container name. You must create the Azure container before creating the repository.
- Base
Path string - Specifies the path within the container to the repository data.
- Chunk
Size string - Maximum size of files in snapshots.
- Client string
- Azure named client to use.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Location
Mode string - Location mode.
primary_only
orsecondary_only
. See: https://docs.microsoft.com/en-us/azure/storage/common/storage-redundancy - Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- container String
- Container name. You must create the Azure container before creating the repository.
- base
Path String - Specifies the path within the container to the repository data.
- chunk
Size String - Maximum size of files in snapshots.
- client String
- Azure named client to use.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- location
Mode String - Location mode.
primary_only
orsecondary_only
. See: https://docs.microsoft.com/en-us/azure/storage/common/storage-redundancy - max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
- container string
- Container name. You must create the Azure container before creating the repository.
- base
Path string - Specifies the path within the container to the repository data.
- chunk
Size string - Maximum size of files in snapshots.
- client string
- Azure named client to use.
- compress boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- location
Mode string - Location mode.
primary_only
orsecondary_only
. See: https://docs.microsoft.com/en-us/azure/storage/common/storage-redundancy - max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly boolean
- If true, the repository is read-only.
- container str
- Container name. You must create the Azure container before creating the repository.
- base_
path str - Specifies the path within the container to the repository data.
- chunk_
size str - Maximum size of files in snapshots.
- client str
- Azure named client to use.
- compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- location_
mode str - Location mode.
primary_only
orsecondary_only
. See: https://docs.microsoft.com/en-us/azure/storage/common/storage-redundancy - max_
restore_ strbytes_ per_ sec - Maximum snapshot restore rate per node.
- max_
snapshot_ strbytes_ per_ sec - Maximum snapshot creation rate per node.
- readonly bool
- If true, the repository is read-only.
- container String
- Container name. You must create the Azure container before creating the repository.
- base
Path String - Specifies the path within the container to the repository data.
- chunk
Size String - Maximum size of files in snapshots.
- client String
- Azure named client to use.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- location
Mode String - Location mode.
primary_only
orsecondary_only
. See: https://docs.microsoft.com/en-us/azure/storage/common/storage-redundancy - max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
ElasticsearchSnapshotRepositoryElasticsearchConnection, ElasticsearchSnapshotRepositoryElasticsearchConnectionArgs
- Api
Key string - API Key to use for authentication to Elasticsearch
- Bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- Ca
Data string - PEM-encoded custom Certificate Authority certificate
- Ca
File string - Path to a custom Certificate Authority certificate
- Cert
Data string - PEM encoded certificate for client auth
- Cert
File string - Path to a file containing the PEM encoded certificate for client auth
- Endpoints List<string>
- Es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- Insecure bool
- Disable TLS certificate validation
- Key
Data string - PEM encoded private key for client auth
- Key
File string - Path to a file containing the PEM encoded private key for client auth
- Password string
- Password to use for API authentication to Elasticsearch.
- Username string
- Username to use for API authentication to Elasticsearch.
- Api
Key string - API Key to use for authentication to Elasticsearch
- Bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- Ca
Data string - PEM-encoded custom Certificate Authority certificate
- Ca
File string - Path to a custom Certificate Authority certificate
- Cert
Data string - PEM encoded certificate for client auth
- Cert
File string - Path to a file containing the PEM encoded certificate for client auth
- Endpoints []string
- Es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- Insecure bool
- Disable TLS certificate validation
- Key
Data string - PEM encoded private key for client auth
- Key
File string - Path to a file containing the PEM encoded private key for client auth
- Password string
- Password to use for API authentication to Elasticsearch.
- Username string
- Username to use for API authentication to Elasticsearch.
- api
Key String - API Key to use for authentication to Elasticsearch
- bearer
Token String - Bearer Token to use for authentication to Elasticsearch
- ca
Data String - PEM-encoded custom Certificate Authority certificate
- ca
File String - Path to a custom Certificate Authority certificate
- cert
Data String - PEM encoded certificate for client auth
- cert
File String - Path to a file containing the PEM encoded certificate for client auth
- endpoints List<String>
- es
Client StringAuthentication - ES Client Authentication field to be used with the JWT token
- insecure Boolean
- Disable TLS certificate validation
- key
Data String - PEM encoded private key for client auth
- key
File String - Path to a file containing the PEM encoded private key for client auth
- password String
- Password to use for API authentication to Elasticsearch.
- username String
- Username to use for API authentication to Elasticsearch.
- api
Key string - API Key to use for authentication to Elasticsearch
- bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- ca
Data string - PEM-encoded custom Certificate Authority certificate
- ca
File string - Path to a custom Certificate Authority certificate
- cert
Data string - PEM encoded certificate for client auth
- cert
File string - Path to a file containing the PEM encoded certificate for client auth
- endpoints string[]
- es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- insecure boolean
- Disable TLS certificate validation
- key
Data string - PEM encoded private key for client auth
- key
File string - Path to a file containing the PEM encoded private key for client auth
- password string
- Password to use for API authentication to Elasticsearch.
- username string
- Username to use for API authentication to Elasticsearch.
- api_
key str - API Key to use for authentication to Elasticsearch
- bearer_
token str - Bearer Token to use for authentication to Elasticsearch
- ca_
data str - PEM-encoded custom Certificate Authority certificate
- ca_
file str - Path to a custom Certificate Authority certificate
- cert_
data str - PEM encoded certificate for client auth
- cert_
file str - Path to a file containing the PEM encoded certificate for client auth
- endpoints Sequence[str]
- es_
client_ strauthentication - ES Client Authentication field to be used with the JWT token
- insecure bool
- Disable TLS certificate validation
- key_
data str - PEM encoded private key for client auth
- key_
file str - Path to a file containing the PEM encoded private key for client auth
- password str
- Password to use for API authentication to Elasticsearch.
- username str
- Username to use for API authentication to Elasticsearch.
- api
Key String - API Key to use for authentication to Elasticsearch
- bearer
Token String - Bearer Token to use for authentication to Elasticsearch
- ca
Data String - PEM-encoded custom Certificate Authority certificate
- ca
File String - Path to a custom Certificate Authority certificate
- cert
Data String - PEM encoded certificate for client auth
- cert
File String - Path to a file containing the PEM encoded certificate for client auth
- endpoints List<String>
- es
Client StringAuthentication - ES Client Authentication field to be used with the JWT token
- insecure Boolean
- Disable TLS certificate validation
- key
Data String - PEM encoded private key for client auth
- key
File String - Path to a file containing the PEM encoded private key for client auth
- password String
- Password to use for API authentication to Elasticsearch.
- username String
- Username to use for API authentication to Elasticsearch.
ElasticsearchSnapshotRepositoryFs, ElasticsearchSnapshotRepositoryFsArgs
- Location string
- Location of the shared filesystem used to store and retrieve snapshots.
- Chunk
Size string - Maximum size of files in snapshots.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Max
Number doubleOf Snapshots - Maximum number of snapshots the repository can contain.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- Location string
- Location of the shared filesystem used to store and retrieve snapshots.
- Chunk
Size string - Maximum size of files in snapshots.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Max
Number float64Of Snapshots - Maximum number of snapshots the repository can contain.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- location String
- Location of the shared filesystem used to store and retrieve snapshots.
- chunk
Size String - Maximum size of files in snapshots.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Number DoubleOf Snapshots - Maximum number of snapshots the repository can contain.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
- location string
- Location of the shared filesystem used to store and retrieve snapshots.
- chunk
Size string - Maximum size of files in snapshots.
- compress boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Number numberOf Snapshots - Maximum number of snapshots the repository can contain.
- max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly boolean
- If true, the repository is read-only.
- location str
- Location of the shared filesystem used to store and retrieve snapshots.
- chunk_
size str - Maximum size of files in snapshots.
- compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max_
number_ floatof_ snapshots - Maximum number of snapshots the repository can contain.
- max_
restore_ strbytes_ per_ sec - Maximum snapshot restore rate per node.
- max_
snapshot_ strbytes_ per_ sec - Maximum snapshot creation rate per node.
- readonly bool
- If true, the repository is read-only.
- location String
- Location of the shared filesystem used to store and retrieve snapshots.
- chunk
Size String - Maximum size of files in snapshots.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Number NumberOf Snapshots - Maximum number of snapshots the repository can contain.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
ElasticsearchSnapshotRepositoryGcs, ElasticsearchSnapshotRepositoryGcsArgs
- Bucket string
- The name of the bucket to be used for snapshots.
- Base
Path string - Specifies the path within the bucket to the repository data. Defaults to the root of the bucket.
- Chunk
Size string - Maximum size of files in snapshots.
- Client string
- The name of the client to use to connect to Google Cloud Storage.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- Bucket string
- The name of the bucket to be used for snapshots.
- Base
Path string - Specifies the path within the bucket to the repository data. Defaults to the root of the bucket.
- Chunk
Size string - Maximum size of files in snapshots.
- Client string
- The name of the client to use to connect to Google Cloud Storage.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- bucket String
- The name of the bucket to be used for snapshots.
- base
Path String - Specifies the path within the bucket to the repository data. Defaults to the root of the bucket.
- chunk
Size String - Maximum size of files in snapshots.
- client String
- The name of the client to use to connect to Google Cloud Storage.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
- bucket string
- The name of the bucket to be used for snapshots.
- base
Path string - Specifies the path within the bucket to the repository data. Defaults to the root of the bucket.
- chunk
Size string - Maximum size of files in snapshots.
- client string
- The name of the client to use to connect to Google Cloud Storage.
- compress boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly boolean
- If true, the repository is read-only.
- bucket str
- The name of the bucket to be used for snapshots.
- base_
path str - Specifies the path within the bucket to the repository data. Defaults to the root of the bucket.
- chunk_
size str - Maximum size of files in snapshots.
- client str
- The name of the client to use to connect to Google Cloud Storage.
- compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max_
restore_ strbytes_ per_ sec - Maximum snapshot restore rate per node.
- max_
snapshot_ strbytes_ per_ sec - Maximum snapshot creation rate per node.
- readonly bool
- If true, the repository is read-only.
- bucket String
- The name of the bucket to be used for snapshots.
- base
Path String - Specifies the path within the bucket to the repository data. Defaults to the root of the bucket.
- chunk
Size String - Maximum size of files in snapshots.
- client String
- The name of the client to use to connect to Google Cloud Storage.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
ElasticsearchSnapshotRepositoryHdfs, ElasticsearchSnapshotRepositoryHdfsArgs
- Path string
- The file path within the filesystem where data is stored/loaded.
- Uri string
- The uri address for hdfs. ex: "hdfs://\n\n:\n\n/".
- Chunk
Size string - Maximum size of files in snapshots.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Load
Defaults bool - Whether to load the default Hadoop configuration or not.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- Path string
- The file path within the filesystem where data is stored/loaded.
- Uri string
- The uri address for hdfs. ex: "hdfs://\n\n:\n\n/".
- Chunk
Size string - Maximum size of files in snapshots.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Load
Defaults bool - Whether to load the default Hadoop configuration or not.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- path String
- The file path within the filesystem where data is stored/loaded.
- uri String
- The uri address for hdfs. ex: "hdfs://\n\n:\n\n/".
- chunk
Size String - Maximum size of files in snapshots.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- load
Defaults Boolean - Whether to load the default Hadoop configuration or not.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
- path string
- The file path within the filesystem where data is stored/loaded.
- uri string
- The uri address for hdfs. ex: "hdfs://\n\n:\n\n/".
- chunk
Size string - Maximum size of files in snapshots.
- compress boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- load
Defaults boolean - Whether to load the default Hadoop configuration or not.
- max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly boolean
- If true, the repository is read-only.
- path str
- The file path within the filesystem where data is stored/loaded.
- uri str
- The uri address for hdfs. ex: "hdfs://\n\n:\n\n/".
- chunk_
size str - Maximum size of files in snapshots.
- compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- load_
defaults bool - Whether to load the default Hadoop configuration or not.
- max_
restore_ strbytes_ per_ sec - Maximum snapshot restore rate per node.
- max_
snapshot_ strbytes_ per_ sec - Maximum snapshot creation rate per node.
- readonly bool
- If true, the repository is read-only.
- path String
- The file path within the filesystem where data is stored/loaded.
- uri String
- The uri address for hdfs. ex: "hdfs://\n\n:\n\n/".
- chunk
Size String - Maximum size of files in snapshots.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- load
Defaults Boolean - Whether to load the default Hadoop configuration or not.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
ElasticsearchSnapshotRepositoryS3, ElasticsearchSnapshotRepositoryS3Args
- Bucket string
- Name of the S3 bucket to use for snapshots.
- Base
Path string - Specifies the path to the repository data within its bucket.
- Buffer
Size string - Minimum threshold below which the chunk is uploaded using a single request.
- Canned
Acl string - The S3 repository supports all S3 canned ACLs.
- Chunk
Size string - Maximum size of files in snapshots.
- Client string
- The name of the S3 client to use to connect to S3.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Path
Style boolAccess - If true, path style access pattern will be used.
- Readonly bool
- If true, the repository is read-only.
- Server
Side boolEncryption - When true, files are encrypted server-side using AES-256 algorithm.
- Storage
Class string - Sets the S3 storage class for objects stored in the snapshot repository.
- Bucket string
- Name of the S3 bucket to use for snapshots.
- Base
Path string - Specifies the path to the repository data within its bucket.
- Buffer
Size string - Minimum threshold below which the chunk is uploaded using a single request.
- Canned
Acl string - The S3 repository supports all S3 canned ACLs.
- Chunk
Size string - Maximum size of files in snapshots.
- Client string
- The name of the S3 client to use to connect to S3.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Path
Style boolAccess - If true, path style access pattern will be used.
- Readonly bool
- If true, the repository is read-only.
- Server
Side boolEncryption - When true, files are encrypted server-side using AES-256 algorithm.
- Storage
Class string - Sets the S3 storage class for objects stored in the snapshot repository.
- bucket String
- Name of the S3 bucket to use for snapshots.
- base
Path String - Specifies the path to the repository data within its bucket.
- buffer
Size String - Minimum threshold below which the chunk is uploaded using a single request.
- canned
Acl String - The S3 repository supports all S3 canned ACLs.
- chunk
Size String - Maximum size of files in snapshots.
- client String
- The name of the S3 client to use to connect to S3.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- path
Style BooleanAccess - If true, path style access pattern will be used.
- readonly Boolean
- If true, the repository is read-only.
- server
Side BooleanEncryption - When true, files are encrypted server-side using AES-256 algorithm.
- storage
Class String - Sets the S3 storage class for objects stored in the snapshot repository.
- bucket string
- Name of the S3 bucket to use for snapshots.
- base
Path string - Specifies the path to the repository data within its bucket.
- buffer
Size string - Minimum threshold below which the chunk is uploaded using a single request.
- canned
Acl string - The S3 repository supports all S3 canned ACLs.
- chunk
Size string - Maximum size of files in snapshots.
- client string
- The name of the S3 client to use to connect to S3.
- compress boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- path
Style booleanAccess - If true, path style access pattern will be used.
- readonly boolean
- If true, the repository is read-only.
- server
Side booleanEncryption - When true, files are encrypted server-side using AES-256 algorithm.
- storage
Class string - Sets the S3 storage class for objects stored in the snapshot repository.
- bucket str
- Name of the S3 bucket to use for snapshots.
- base_
path str - Specifies the path to the repository data within its bucket.
- buffer_
size str - Minimum threshold below which the chunk is uploaded using a single request.
- canned_
acl str - The S3 repository supports all S3 canned ACLs.
- chunk_
size str - Maximum size of files in snapshots.
- client str
- The name of the S3 client to use to connect to S3.
- compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max_
restore_ strbytes_ per_ sec - Maximum snapshot restore rate per node.
- max_
snapshot_ strbytes_ per_ sec - Maximum snapshot creation rate per node.
- path_
style_ boolaccess - If true, path style access pattern will be used.
- readonly bool
- If true, the repository is read-only.
- server_
side_ boolencryption - When true, files are encrypted server-side using AES-256 algorithm.
- storage_
class str - Sets the S3 storage class for objects stored in the snapshot repository.
- bucket String
- Name of the S3 bucket to use for snapshots.
- base
Path String - Specifies the path to the repository data within its bucket.
- buffer
Size String - Minimum threshold below which the chunk is uploaded using a single request.
- canned
Acl String - The S3 repository supports all S3 canned ACLs.
- chunk
Size String - Maximum size of files in snapshots.
- client String
- The name of the S3 client to use to connect to S3.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- path
Style BooleanAccess - If true, path style access pattern will be used.
- readonly Boolean
- If true, the repository is read-only.
- server
Side BooleanEncryption - When true, files are encrypted server-side using AES-256 algorithm.
- storage
Class String - Sets the S3 storage class for objects stored in the snapshot repository.
ElasticsearchSnapshotRepositoryUrl, ElasticsearchSnapshotRepositoryUrlArgs
- Url string
- URL location of the root of the shared filesystem repository.
- Chunk
Size string - Maximum size of files in snapshots.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Http
Max doubleRetries - Maximum number of retries for http and https URLs.
- Http
Socket stringTimeout - Maximum wait time for data transfers over a connection.
- Max
Number doubleOf Snapshots - Maximum number of snapshots the repository can contain.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- Url string
- URL location of the root of the shared filesystem repository.
- Chunk
Size string - Maximum size of files in snapshots.
- Compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- Http
Max float64Retries - Maximum number of retries for http and https URLs.
- Http
Socket stringTimeout - Maximum wait time for data transfers over a connection.
- Max
Number float64Of Snapshots - Maximum number of snapshots the repository can contain.
- Max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- Max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- Readonly bool
- If true, the repository is read-only.
- url String
- URL location of the root of the shared filesystem repository.
- chunk
Size String - Maximum size of files in snapshots.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- http
Max DoubleRetries - Maximum number of retries for http and https URLs.
- http
Socket StringTimeout - Maximum wait time for data transfers over a connection.
- max
Number DoubleOf Snapshots - Maximum number of snapshots the repository can contain.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
- url string
- URL location of the root of the shared filesystem repository.
- chunk
Size string - Maximum size of files in snapshots.
- compress boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- http
Max numberRetries - Maximum number of retries for http and https URLs.
- http
Socket stringTimeout - Maximum wait time for data transfers over a connection.
- max
Number numberOf Snapshots - Maximum number of snapshots the repository can contain.
- max
Restore stringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot stringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly boolean
- If true, the repository is read-only.
- url str
- URL location of the root of the shared filesystem repository.
- chunk_
size str - Maximum size of files in snapshots.
- compress bool
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- http_
max_ floatretries - Maximum number of retries for http and https URLs.
- http_
socket_ strtimeout - Maximum wait time for data transfers over a connection.
- max_
number_ floatof_ snapshots - Maximum number of snapshots the repository can contain.
- max_
restore_ strbytes_ per_ sec - Maximum snapshot restore rate per node.
- max_
snapshot_ strbytes_ per_ sec - Maximum snapshot creation rate per node.
- readonly bool
- If true, the repository is read-only.
- url String
- URL location of the root of the shared filesystem repository.
- chunk
Size String - Maximum size of files in snapshots.
- compress Boolean
- If true, metadata files, such as index mappings and settings, are compressed in snapshots.
- http
Max NumberRetries - Maximum number of retries for http and https URLs.
- http
Socket StringTimeout - Maximum wait time for data transfers over a connection.
- max
Number NumberOf Snapshots - Maximum number of snapshots the repository can contain.
- max
Restore StringBytes Per Sec - Maximum snapshot restore rate per node.
- max
Snapshot StringBytes Per Sec - Maximum snapshot creation rate per node.
- readonly Boolean
- If true, the repository is read-only.
Import
$ pulumi import elasticstack:index/elasticsearchSnapshotRepository:ElasticsearchSnapshotRepository my_repository <cluster_uuid>/<repository name>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstack
Terraform Provider.