elasticstack.getElasticsearchSynonymSet

elasticstack 0.16.1, Jun 1 26

Viewing docs for elasticstack 0.16.1
published on Monday, Jun 1, 2026 by elastic

Using getElasticsearchSynonymSet

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 getElasticsearchSynonymSet(args: GetElasticsearchSynonymSetArgs, opts?: InvokeOptions): Promise<GetElasticsearchSynonymSetResult>
function getElasticsearchSynonymSetOutput(args: GetElasticsearchSynonymSetOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchSynonymSetResult>

def get_elasticsearch_synonym_set(elasticsearch_connections: Optional[Sequence[GetElasticsearchSynonymSetElasticsearchConnection]] = None,
                                  synonym_set_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetElasticsearchSynonymSetResult
def get_elasticsearch_synonym_set_output(elasticsearch_connections: pulumi.Input[Optional[Sequence[pulumi.Input[GetElasticsearchSynonymSetElasticsearchConnectionArgs]]]] = None,
                                  synonym_set_id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchSynonymSetResult]

func LookupElasticsearchSynonymSet(ctx *Context, args *LookupElasticsearchSynonymSetArgs, opts ...InvokeOption) (*LookupElasticsearchSynonymSetResult, error)
func LookupElasticsearchSynonymSetOutput(ctx *Context, args *LookupElasticsearchSynonymSetOutputArgs, opts ...InvokeOption) LookupElasticsearchSynonymSetResultOutput

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

public static class GetElasticsearchSynonymSet 
{
    public static Task<GetElasticsearchSynonymSetResult> InvokeAsync(GetElasticsearchSynonymSetArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchSynonymSetResult> Invoke(GetElasticsearchSynonymSetInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetElasticsearchSynonymSetResult> getElasticsearchSynonymSet(GetElasticsearchSynonymSetArgs args, InvokeOptions options)
public static Output<GetElasticsearchSynonymSetResult> getElasticsearchSynonymSet(GetElasticsearchSynonymSetArgs args, InvokeOptions options)

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

data "elasticstack_getelasticsearchsynonymset" "name" {
    # arguments
}

The following arguments are supported:

SynonymSetId string: The name of the synonym set to look up.
ElasticsearchConnections List<GetElasticsearchSynonymSetElasticsearchConnection>: Elasticsearch connection configuration block.

SynonymSetId string: The name of the synonym set to look up.
ElasticsearchConnections []GetElasticsearchSynonymSetElasticsearchConnection: Elasticsearch connection configuration block.

synonym_set_id string: The name of the synonym set to look up.
elasticsearch_connections list(object): Elasticsearch connection configuration block.

synonymSetId String: The name of the synonym set to look up.
elasticsearchConnections List<GetElasticsearchSynonymSetElasticsearchConnection>: Elasticsearch connection configuration block.

synonymSetId string: The name of the synonym set to look up.
elasticsearchConnections GetElasticsearchSynonymSetElasticsearchConnection[]: Elasticsearch connection configuration block.

synonym_set_id str: The name of the synonym set to look up.
elasticsearch_connections Sequence[GetElasticsearchSynonymSetElasticsearchConnection]: Elasticsearch connection configuration block.

synonymSetId String: The name of the synonym set to look up.
elasticsearchConnections List<Property Map>: Elasticsearch connection configuration block.

getElasticsearchSynonymSet Result

The following output properties are available:

Id string: Internal identifier of the resource.
SynonymSetId string: The name of the synonym set to look up.
SynonymsSets List<GetElasticsearchSynonymSetSynonymsSet>: The list of synonym rules for this synonym set.
ElasticsearchConnections List<GetElasticsearchSynonymSetElasticsearchConnection>: Elasticsearch connection configuration block.

Id string: Internal identifier of the resource.
SynonymSetId string: The name of the synonym set to look up.
SynonymsSets []GetElasticsearchSynonymSetSynonymsSet: The list of synonym rules for this synonym set.
ElasticsearchConnections []GetElasticsearchSynonymSetElasticsearchConnection: Elasticsearch connection configuration block.

id string: Internal identifier of the resource.
synonym_set_id string: The name of the synonym set to look up.
synonyms_sets list(object): The list of synonym rules for this synonym set.
elasticsearch_connections list(object): Elasticsearch connection configuration block.

id String: Internal identifier of the resource.
synonymSetId String: The name of the synonym set to look up.
synonymsSets List<GetElasticsearchSynonymSetSynonymsSet>: The list of synonym rules for this synonym set.
elasticsearchConnections List<GetElasticsearchSynonymSetElasticsearchConnection>: Elasticsearch connection configuration block.

id string: Internal identifier of the resource.
synonymSetId string: The name of the synonym set to look up.
synonymsSets GetElasticsearchSynonymSetSynonymsSet[]: The list of synonym rules for this synonym set.
elasticsearchConnections GetElasticsearchSynonymSetElasticsearchConnection[]: Elasticsearch connection configuration block.

id str: Internal identifier of the resource.
synonym_set_id str: The name of the synonym set to look up.
synonyms_sets Sequence[GetElasticsearchSynonymSetSynonymsSet]: The list of synonym rules for this synonym set.
elasticsearch_connections Sequence[GetElasticsearchSynonymSetElasticsearchConnection]: Elasticsearch connection configuration block.

id String: Internal identifier of the resource.
synonymSetId String: The name of the synonym set to look up.
synonymsSets List<Property Map>: The list of synonym rules for this synonym set.
elasticsearchConnections List<Property Map>: Elasticsearch connection configuration block.

Supporting Types

GetElasticsearchSynonymSetElasticsearchConnection

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
Headers Dictionary<string, string>: A list of headers to be sent with each request to Elasticsearch.
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
Headers map[string]string: A list of headers to be sent with each request to Elasticsearch.
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.

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_authentication string: ES Client Authentication field to be used with the JWT token
headers map(string): A list of headers to be sent with each request to Elasticsearch.
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.

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
headers Map<String,String>: A list of headers to be sent with each request to Elasticsearch.
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
headers {[key: string]: string}: A list of headers to be sent with each request to Elasticsearch.
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
headers Mapping[str, str]: A list of headers to be sent with each request to Elasticsearch.
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
headers Map<String>: A list of headers to be sent with each request to Elasticsearch.
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.

GetElasticsearchSynonymSetSynonymsSet

Id string: The identifier for this synonym rule.
Synonyms string: The synonym rule in Solr format (e.g. "i-pod, i pod => ipod" or "universe, cosmos").

Id string: The identifier for this synonym rule.
Synonyms string: The synonym rule in Solr format (e.g. "i-pod, i pod => ipod" or "universe, cosmos").

id string: The identifier for this synonym rule.
synonyms string: The synonym rule in Solr format (e.g. "i-pod, i pod => ipod" or "universe, cosmos").

id String: The identifier for this synonym rule.
synonyms String: The synonym rule in Solr format (e.g. "i-pod, i pod => ipod" or "universe, cosmos").

id string: The identifier for this synonym rule.
synonyms string: The synonym rule in Solr format (e.g. "i-pod, i pod => ipod" or "universe, cosmos").

id str: The identifier for this synonym rule.
synonyms str: The synonym rule in Solr format (e.g. "i-pod, i pod => ipod" or "universe, cosmos").

id String: The identifier for this synonym rule.
synonyms String: The synonym rule in Solr format (e.g. "i-pod, i pod => ipod" or "universe, cosmos").

Package Details

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

Viewing docs for elasticstack 0.16.1
published on Monday, Jun 1, 2026 by elastic

Schema (JSON)

elastic/terraform-provider-elasticstack

elasticstack.getElasticsearchSynonymSet

On this page

On this page

Using getElasticsearchSynonymSet

getElasticsearchSynonymSet Result

Supporting Types

GetElasticsearchSynonymSetElasticsearchConnection

GetElasticsearchSynonymSetSynonymsSet

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

elasticstack.getElasticsearchSynonymSet

On this page

On this page

Using getElasticsearchSynonymSet

getElasticsearchSynonymSet Result

Supporting Types

GetElasticsearchSynonymSetElasticsearchConnection

GetElasticsearchSynonymSetSynonymsSet

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.