elasticstack 0.11.15, Apr 23 25

elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elasticstack.getElasticsearchSnapshotRepository

Explore with Pulumi AI

elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

Using getElasticsearchSnapshotRepository

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getElasticsearchSnapshotRepository(args: GetElasticsearchSnapshotRepositoryArgs, opts?: InvokeOptions): Promise<GetElasticsearchSnapshotRepositoryResult>
function getElasticsearchSnapshotRepositoryOutput(args: GetElasticsearchSnapshotRepositoryOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchSnapshotRepositoryResult>

def get_elasticsearch_snapshot_repository(elasticsearch_connection: Optional[GetElasticsearchSnapshotRepositoryElasticsearchConnection] = None,
                                          name: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetElasticsearchSnapshotRepositoryResult
def get_elasticsearch_snapshot_repository_output(elasticsearch_connection: Optional[pulumi.Input[GetElasticsearchSnapshotRepositoryElasticsearchConnectionArgs]] = None,
                                          name: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchSnapshotRepositoryResult]

func LookupElasticsearchSnapshotRepository(ctx *Context, args *LookupElasticsearchSnapshotRepositoryArgs, opts ...InvokeOption) (*LookupElasticsearchSnapshotRepositoryResult, error)
func LookupElasticsearchSnapshotRepositoryOutput(ctx *Context, args *LookupElasticsearchSnapshotRepositoryOutputArgs, opts ...InvokeOption) LookupElasticsearchSnapshotRepositoryResultOutput

> Note: This function is named LookupElasticsearchSnapshotRepository in the Go SDK.

public static class GetElasticsearchSnapshotRepository 
{
    public static Task<GetElasticsearchSnapshotRepositoryResult> InvokeAsync(GetElasticsearchSnapshotRepositoryArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchSnapshotRepositoryResult> Invoke(GetElasticsearchSnapshotRepositoryInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetElasticsearchSnapshotRepositoryResult> getElasticsearchSnapshotRepository(GetElasticsearchSnapshotRepositoryArgs args, InvokeOptions options)
public static Output<GetElasticsearchSnapshotRepositoryResult> getElasticsearchSnapshotRepository(GetElasticsearchSnapshotRepositoryArgs args, InvokeOptions options)

fn::invoke:
  function: elasticstack:index/getElasticsearchSnapshotRepository:getElasticsearchSnapshotRepository
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the snapshot repository.
ElasticsearchConnection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

Name string: Name of the snapshot repository.
ElasticsearchConnection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

name String: Name of the snapshot repository.
elasticsearchConnection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

name string: Name of the snapshot repository.
elasticsearchConnection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

name str: Name of the snapshot repository.
elasticsearch_connection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

name String: Name of the snapshot repository.
elasticsearchConnection 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.
Deprecated: Deprecated

getElasticsearchSnapshotRepository Result

The following output properties are available:

Azures List<GetElasticsearchSnapshotRepositoryAzure>: Azure Blob storage as a repository. Set only if the type of the fetched repo is azure.
Fs List<GetElasticsearchSnapshotRepositoryF>: Shared filesystem repository. Set only if the type of the fetched repo is fs.
Gcs List<GetElasticsearchSnapshotRepositoryGc>: Google Cloud Storage service as a repository. Set only if the type of the fetched repo is gcs.
Hdfs List<GetElasticsearchSnapshotRepositoryHdf>: HDFS File System as a repository. Set only if the type of the fetched repo is hdfs.
Id string: Internal identifier of the resource
Name string: Name of the snapshot repository.
S3s List<GetElasticsearchSnapshotRepositoryS3>: AWS S3 as a repository. Set only if the type of the fetched repo is s3.
Type string: Repository type.
Urls List<GetElasticsearchSnapshotRepositoryUrl>: URL repository. Set only if the type of the fetched repo is url.
ElasticsearchConnection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

Azures []GetElasticsearchSnapshotRepositoryAzure: Azure Blob storage as a repository. Set only if the type of the fetched repo is azure.
Fs []GetElasticsearchSnapshotRepositoryF: Shared filesystem repository. Set only if the type of the fetched repo is fs.
Gcs []GetElasticsearchSnapshotRepositoryGc: Google Cloud Storage service as a repository. Set only if the type of the fetched repo is gcs.
Hdfs []GetElasticsearchSnapshotRepositoryHdf: HDFS File System as a repository. Set only if the type of the fetched repo is hdfs.
Id string: Internal identifier of the resource
Name string: Name of the snapshot repository.
S3s []GetElasticsearchSnapshotRepositoryS3: AWS S3 as a repository. Set only if the type of the fetched repo is s3.
Type string: Repository type.
Urls []GetElasticsearchSnapshotRepositoryUrl: URL repository. Set only if the type of the fetched repo is url.
ElasticsearchConnection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

azures List<GetElasticsearchSnapshotRepositoryAzure>: Azure Blob storage as a repository. Set only if the type of the fetched repo is azure.
fs List<GetElasticsearchSnapshotRepositoryF>: Shared filesystem repository. Set only if the type of the fetched repo is fs.
gcs List<GetElasticsearchSnapshotRepositoryGc>: Google Cloud Storage service as a repository. Set only if the type of the fetched repo is gcs.
hdfs List<GetElasticsearchSnapshotRepositoryHdf>: HDFS File System as a repository. Set only if the type of the fetched repo is hdfs.
id String: Internal identifier of the resource
name String: Name of the snapshot repository.
s3s List<GetElasticsearchSnapshotRepositoryS3>: AWS S3 as a repository. Set only if the type of the fetched repo is s3.
type String: Repository type.
urls List<GetElasticsearchSnapshotRepositoryUrl>: URL repository. Set only if the type of the fetched repo is url.
elasticsearchConnection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

azures GetElasticsearchSnapshotRepositoryAzure[]: Azure Blob storage as a repository. Set only if the type of the fetched repo is azure.
fs GetElasticsearchSnapshotRepositoryF[]: Shared filesystem repository. Set only if the type of the fetched repo is fs.
gcs GetElasticsearchSnapshotRepositoryGc[]: Google Cloud Storage service as a repository. Set only if the type of the fetched repo is gcs.
hdfs GetElasticsearchSnapshotRepositoryHdf[]: HDFS File System as a repository. Set only if the type of the fetched repo is hdfs.
id string: Internal identifier of the resource
name string: Name of the snapshot repository.
s3s GetElasticsearchSnapshotRepositoryS3[]: AWS S3 as a repository. Set only if the type of the fetched repo is s3.
type string: Repository type.
urls GetElasticsearchSnapshotRepositoryUrl[]: URL repository. Set only if the type of the fetched repo is url.
elasticsearchConnection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

azures Sequence[GetElasticsearchSnapshotRepositoryAzure]: Azure Blob storage as a repository. Set only if the type of the fetched repo is azure.
fs Sequence[GetElasticsearchSnapshotRepositoryF]: Shared filesystem repository. Set only if the type of the fetched repo is fs.
gcs Sequence[GetElasticsearchSnapshotRepositoryGc]: Google Cloud Storage service as a repository. Set only if the type of the fetched repo is gcs.
hdfs Sequence[GetElasticsearchSnapshotRepositoryHdf]: HDFS File System as a repository. Set only if the type of the fetched repo is hdfs.
id str: Internal identifier of the resource
name str: Name of the snapshot repository.
s3s Sequence[GetElasticsearchSnapshotRepositoryS3]: AWS S3 as a repository. Set only if the type of the fetched repo is s3.
type str: Repository type.
urls Sequence[GetElasticsearchSnapshotRepositoryUrl]: URL repository. Set only if the type of the fetched repo is url.
elasticsearch_connection GetElasticsearchSnapshotRepositoryElasticsearchConnection: Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
Deprecated: Deprecated

azures List<Property Map>: Azure Blob storage as a repository. Set only if the type of the fetched repo is azure.
fs List<Property Map>: Shared filesystem repository. Set only if the type of the fetched repo is fs.
gcs List<Property Map>: Google Cloud Storage service as a repository. Set only if the type of the fetched repo is gcs.
hdfs List<Property Map>: HDFS File System as a repository. Set only if the type of the fetched repo is hdfs.
id String: Internal identifier of the resource
name String: Name of the snapshot repository.
s3s List<Property Map>: AWS S3 as a repository. Set only if the type of the fetched repo is s3.
type String: Repository type.
urls List<Property Map>: URL repository. Set only if the type of the fetched repo is url.
elasticsearchConnection 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.
Deprecated: Deprecated

Supporting Types

GetElasticsearchSnapshotRepositoryAzure

BasePath string
ChunkSize string
Client string
Compress bool
Container string
LocationMode string
MaxRestoreBytesPerSec string
MaxSnapshotBytesPerSec string
Readonly bool

BasePath string
ChunkSize string
Client string
Compress bool
Container string
LocationMode string
MaxRestoreBytesPerSec string
MaxSnapshotBytesPerSec string
Readonly bool

basePath String
chunkSize String
client String
compress Boolean
container String
locationMode String
maxRestoreBytesPerSec String
maxSnapshotBytesPerSec String
readonly Boolean

basePath string
chunkSize string
client string
compress boolean
container string
locationMode string
maxRestoreBytesPerSec string
maxSnapshotBytesPerSec string
readonly boolean

base_path str
chunk_size str
client str
compress bool
container str
location_mode str
max_restore_bytes_per_sec str
max_snapshot_bytes_per_sec str
readonly bool

basePath String
chunkSize String
client String
compress Boolean
container String
locationMode String
maxRestoreBytesPerSec String
maxSnapshotBytesPerSec String
readonly Boolean

GetElasticsearchSnapshotRepositoryElasticsearchConnection

ApiKey string: API Key to use for authentication to Elasticsearch
BearerToken string: Bearer Token to use for authentication to Elasticsearch
CaData string: PEM-encoded custom Certificate Authority certificate
CaFile string: Path to a custom Certificate Authority certificate
CertData string: PEM encoded certificate for client auth
CertFile string: Path to a file containing the PEM encoded certificate for client auth
Endpoints List<string>
EsClientAuthentication string: ES Client Authentication field to be used with the JWT token
Insecure bool: Disable TLS certificate validation
KeyData string: PEM encoded private key for client auth
KeyFile 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.

ApiKey string: API Key to use for authentication to Elasticsearch
BearerToken string: Bearer Token to use for authentication to Elasticsearch
CaData string: PEM-encoded custom Certificate Authority certificate
CaFile string: Path to a custom Certificate Authority certificate
CertData string: PEM encoded certificate for client auth
CertFile string: Path to a file containing the PEM encoded certificate for client auth
Endpoints []string
EsClientAuthentication string: ES Client Authentication field to be used with the JWT token
Insecure bool: Disable TLS certificate validation
KeyData string: PEM encoded private key for client auth
KeyFile 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.

apiKey String: API Key to use for authentication to Elasticsearch
bearerToken String: Bearer Token to use for authentication to Elasticsearch
caData String: PEM-encoded custom Certificate Authority certificate
caFile String: Path to a custom Certificate Authority certificate
certData String: PEM encoded certificate for client auth
certFile String: Path to a file containing the PEM encoded certificate for client auth
endpoints List<String>
esClientAuthentication String: ES Client Authentication field to be used with the JWT token
insecure Boolean: Disable TLS certificate validation
keyData String: PEM encoded private key for client auth
keyFile 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.

apiKey string: API Key to use for authentication to Elasticsearch
bearerToken string: Bearer Token to use for authentication to Elasticsearch
caData string: PEM-encoded custom Certificate Authority certificate
caFile string: Path to a custom Certificate Authority certificate
certData string: PEM encoded certificate for client auth
certFile string: Path to a file containing the PEM encoded certificate for client auth
endpoints string[]
esClientAuthentication string: ES Client Authentication field to be used with the JWT token
insecure boolean: Disable TLS certificate validation
keyData string: PEM encoded private key for client auth
keyFile 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_authentication str: 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.

apiKey String: API Key to use for authentication to Elasticsearch
bearerToken String: Bearer Token to use for authentication to Elasticsearch
caData String: PEM-encoded custom Certificate Authority certificate
caFile String: Path to a custom Certificate Authority certificate
certData String: PEM encoded certificate for client auth
certFile String: Path to a file containing the PEM encoded certificate for client auth
endpoints List<String>
esClientAuthentication String: ES Client Authentication field to be used with the JWT token
insecure Boolean: Disable TLS certificate validation
keyData String: PEM encoded private key for client auth
keyFile 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.

Package Details

Repository: elasticstack elastic/terraform-provider-elasticstack
License
Notes: This Pulumi package is based on the elasticstack Terraform Provider.

elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elastic/terraform-provider-elasticstack

elasticstack.getElasticsearchSnapshotRepository

On this page

On this page

Using getElasticsearchSnapshotRepository

getElasticsearchSnapshotRepository Result

Supporting Types

GetElasticsearchSnapshotRepositoryAzure

GetElasticsearchSnapshotRepositoryElasticsearchConnection

GetElasticsearchSnapshotRepositoryF

GetElasticsearchSnapshotRepositoryGc

GetElasticsearchSnapshotRepositoryHdf

GetElasticsearchSnapshotRepositoryS3

GetElasticsearchSnapshotRepositoryUrl

Package Details

On this page

On this page