elasticstack.ElasticsearchSynonymSet

elasticstack 0.16.1, Jun 1 26

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

Create ElasticsearchSynonymSet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ElasticsearchSynonymSet(name: string, args: ElasticsearchSynonymSetArgs, opts?: CustomResourceOptions);

@overload
def ElasticsearchSynonymSet(resource_name: str,
                            args: ElasticsearchSynonymSetArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def ElasticsearchSynonymSet(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            synonym_set_id: Optional[str] = None,
                            synonyms_sets: Optional[Sequence[ElasticsearchSynonymSetSynonymsSetArgs]] = None,
                            elasticsearch_connections: Optional[Sequence[ElasticsearchSynonymSetElasticsearchConnectionArgs]] = None)

func NewElasticsearchSynonymSet(ctx *Context, name string, args ElasticsearchSynonymSetArgs, opts ...ResourceOption) (*ElasticsearchSynonymSet, error)

public ElasticsearchSynonymSet(string name, ElasticsearchSynonymSetArgs args, CustomResourceOptions? opts = null)

public ElasticsearchSynonymSet(String name, ElasticsearchSynonymSetArgs args)
public ElasticsearchSynonymSet(String name, ElasticsearchSynonymSetArgs args, CustomResourceOptions options)

type: elasticstack:ElasticsearchSynonymSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "elasticstack_elasticsearchsynonymset" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args ElasticsearchSynonymSetArgs: 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 ElasticsearchSynonymSetArgs: 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 ElasticsearchSynonymSetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ElasticsearchSynonymSetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ElasticsearchSynonymSetArgs: 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 elasticsearchSynonymSetResource = new Elasticstack.ElasticsearchSynonymSet("elasticsearchSynonymSetResource", new()
{
    SynonymSetId = "string",
    SynonymsSets = new[]
    {
        new Elasticstack.Inputs.ElasticsearchSynonymSetSynonymsSetArgs
        {
            Synonyms = "string",
            Id = "string",
        },
    },
    ElasticsearchConnections = new[]
    {
        new Elasticstack.Inputs.ElasticsearchSynonymSetElasticsearchConnectionArgs
        {
            ApiKey = "string",
            BearerToken = "string",
            CaData = "string",
            CaFile = "string",
            CertData = "string",
            CertFile = "string",
            Endpoints = new[]
            {
                "string",
            },
            EsClientAuthentication = "string",
            Headers = 
            {
                { "string", "string" },
            },
            Insecure = false,
            KeyData = "string",
            KeyFile = "string",
            Password = "string",
            Username = "string",
        },
    },
});

example, err := elasticstack.NewElasticsearchSynonymSet(ctx, "elasticsearchSynonymSetResource", &elasticstack.ElasticsearchSynonymSetArgs{
	SynonymSetId: pulumi.String("string"),
	SynonymsSets: elasticstack.ElasticsearchSynonymSetSynonymsSetArray{
		&elasticstack.ElasticsearchSynonymSetSynonymsSetArgs{
			Synonyms: pulumi.String("string"),
			Id:       pulumi.String("string"),
		},
	},
	ElasticsearchConnections: elasticstack.ElasticsearchSynonymSetElasticsearchConnectionArray{
		&elasticstack.ElasticsearchSynonymSetElasticsearchConnectionArgs{
			ApiKey:      pulumi.String("string"),
			BearerToken: pulumi.String("string"),
			CaData:      pulumi.String("string"),
			CaFile:      pulumi.String("string"),
			CertData:    pulumi.String("string"),
			CertFile:    pulumi.String("string"),
			Endpoints: pulumi.StringArray{
				pulumi.String("string"),
			},
			EsClientAuthentication: pulumi.String("string"),
			Headers: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Insecure: pulumi.Bool(false),
			KeyData:  pulumi.String("string"),
			KeyFile:  pulumi.String("string"),
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
	},
})

resource "elasticstack_elasticsearchsynonymset" "elasticsearchSynonymSetResource" {
  synonym_set_id = "string"
  synonyms_sets {
    synonyms = "string"
    id       = "string"
  }
  elasticsearch_connections {
    api_key                  = "string"
    bearer_token             = "string"
    ca_data                  = "string"
    ca_file                  = "string"
    cert_data                = "string"
    cert_file                = "string"
    endpoints                = ["string"]
    es_client_authentication = "string"
    headers = {
      "string" = "string"
    }
    insecure = false
    key_data = "string"
    key_file = "string"
    password = "string"
    username = "string"
  }
}

var elasticsearchSynonymSetResource = new ElasticsearchSynonymSet("elasticsearchSynonymSetResource", ElasticsearchSynonymSetArgs.builder()
    .synonymSetId("string")
    .synonymsSets(ElasticsearchSynonymSetSynonymsSetArgs.builder()
        .synonyms("string")
        .id("string")
        .build())
    .elasticsearchConnections(ElasticsearchSynonymSetElasticsearchConnectionArgs.builder()
        .apiKey("string")
        .bearerToken("string")
        .caData("string")
        .caFile("string")
        .certData("string")
        .certFile("string")
        .endpoints("string")
        .esClientAuthentication("string")
        .headers(Map.of("string", "string"))
        .insecure(false)
        .keyData("string")
        .keyFile("string")
        .password("string")
        .username("string")
        .build())
    .build());

elasticsearch_synonym_set_resource = elasticstack.ElasticsearchSynonymSet("elasticsearchSynonymSetResource",
    synonym_set_id="string",
    synonyms_sets=[{
        "synonyms": "string",
        "id": "string",
    }],
    elasticsearch_connections=[{
        "api_key": "string",
        "bearer_token": "string",
        "ca_data": "string",
        "ca_file": "string",
        "cert_data": "string",
        "cert_file": "string",
        "endpoints": ["string"],
        "es_client_authentication": "string",
        "headers": {
            "string": "string",
        },
        "insecure": False,
        "key_data": "string",
        "key_file": "string",
        "password": "string",
        "username": "string",
    }])

const elasticsearchSynonymSetResource = new elasticstack.ElasticsearchSynonymSet("elasticsearchSynonymSetResource", {
    synonymSetId: "string",
    synonymsSets: [{
        synonyms: "string",
        id: "string",
    }],
    elasticsearchConnections: [{
        apiKey: "string",
        bearerToken: "string",
        caData: "string",
        caFile: "string",
        certData: "string",
        certFile: "string",
        endpoints: ["string"],
        esClientAuthentication: "string",
        headers: {
            string: "string",
        },
        insecure: false,
        keyData: "string",
        keyFile: "string",
        password: "string",
        username: "string",
    }],
});

type: elasticstack:ElasticsearchSynonymSet
properties:
    elasticsearchConnections:
        - apiKey: string
          bearerToken: string
          caData: string
          caFile: string
          certData: string
          certFile: string
          endpoints:
            - string
          esClientAuthentication: string
          headers:
            string: string
          insecure: false
          keyData: string
          keyFile: string
          password: string
          username: string
    synonymSetId: string
    synonymsSets:
        - id: string
          synonyms: string

ElasticsearchSynonymSet 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 ElasticsearchSynonymSet resource accepts the following input properties:

SynonymSetId string: The name of the synonym set. Must be unique within the Elasticsearch cluster.
SynonymsSets List<ElasticsearchSynonymSetSynonymsSet>: The list of synonym rules for this synonym set.
ElasticsearchConnections List<ElasticsearchSynonymSetElasticsearchConnection>: Elasticsearch connection configuration block.

SynonymSetId string: The name of the synonym set. Must be unique within the Elasticsearch cluster.
SynonymsSets []ElasticsearchSynonymSetSynonymsSetArgs: The list of synonym rules for this synonym set.
ElasticsearchConnections []ElasticsearchSynonymSetElasticsearchConnectionArgs: Elasticsearch connection configuration block.

synonym_set_id string: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonyms_sets list(object): The list of synonym rules for this synonym set.
elasticsearch_connections list(object): Elasticsearch connection configuration block.

synonymSetId String: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonymsSets List<ElasticsearchSynonymSetSynonymsSet>: The list of synonym rules for this synonym set.
elasticsearchConnections List<ElasticsearchSynonymSetElasticsearchConnection>: Elasticsearch connection configuration block.

synonymSetId string: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonymsSets ElasticsearchSynonymSetSynonymsSet[]: The list of synonym rules for this synonym set.
elasticsearchConnections ElasticsearchSynonymSetElasticsearchConnection[]: Elasticsearch connection configuration block.

synonym_set_id str: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonyms_sets Sequence[ElasticsearchSynonymSetSynonymsSetArgs]: The list of synonym rules for this synonym set.
elasticsearch_connections Sequence[ElasticsearchSynonymSetElasticsearchConnectionArgs]: Elasticsearch connection configuration block.

synonymSetId String: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonymsSets List<Property Map>: The list of synonym rules for this synonym set.
elasticsearchConnections List<Property Map>: Elasticsearch connection configuration block.

Outputs

All input properties are implicitly available as output properties. Additionally, the ElasticsearchSynonymSet 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 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 ElasticsearchSynonymSet Resource

Get an existing ElasticsearchSynonymSet 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?: ElasticsearchSynonymSetState, opts?: CustomResourceOptions): ElasticsearchSynonymSet

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        elasticsearch_connections: Optional[Sequence[ElasticsearchSynonymSetElasticsearchConnectionArgs]] = None,
        synonym_set_id: Optional[str] = None,
        synonyms_sets: Optional[Sequence[ElasticsearchSynonymSetSynonymsSetArgs]] = None) -> ElasticsearchSynonymSet

func GetElasticsearchSynonymSet(ctx *Context, name string, id IDInput, state *ElasticsearchSynonymSetState, opts ...ResourceOption) (*ElasticsearchSynonymSet, error)

public static ElasticsearchSynonymSet Get(string name, Input<string> id, ElasticsearchSynonymSetState? state, CustomResourceOptions? opts = null)

public static ElasticsearchSynonymSet get(String name, Output<String> id, ElasticsearchSynonymSetState state, CustomResourceOptions options)

resources:  _:    type: elasticstack:ElasticsearchSynonymSet    get:      id: ${id}

import {
  to = elasticstack_elasticsearchsynonymset.example
  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.

The following state arguments are supported:

ElasticsearchConnections List<ElasticsearchSynonymSetElasticsearchConnection>: Elasticsearch connection configuration block.
SynonymSetId string: The name of the synonym set. Must be unique within the Elasticsearch cluster.
SynonymsSets List<ElasticsearchSynonymSetSynonymsSet>: The list of synonym rules for this synonym set.

ElasticsearchConnections []ElasticsearchSynonymSetElasticsearchConnectionArgs: Elasticsearch connection configuration block.
SynonymSetId string: The name of the synonym set. Must be unique within the Elasticsearch cluster.
SynonymsSets []ElasticsearchSynonymSetSynonymsSetArgs: The list of synonym rules for this synonym set.

elasticsearch_connections list(object): Elasticsearch connection configuration block.
synonym_set_id string: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonyms_sets list(object): The list of synonym rules for this synonym set.

elasticsearchConnections List<ElasticsearchSynonymSetElasticsearchConnection>: Elasticsearch connection configuration block.
synonymSetId String: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonymsSets List<ElasticsearchSynonymSetSynonymsSet>: The list of synonym rules for this synonym set.

elasticsearchConnections ElasticsearchSynonymSetElasticsearchConnection[]: Elasticsearch connection configuration block.
synonymSetId string: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonymsSets ElasticsearchSynonymSetSynonymsSet[]: The list of synonym rules for this synonym set.

elasticsearch_connections Sequence[ElasticsearchSynonymSetElasticsearchConnectionArgs]: Elasticsearch connection configuration block.
synonym_set_id str: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonyms_sets Sequence[ElasticsearchSynonymSetSynonymsSetArgs]: The list of synonym rules for this synonym set.

elasticsearchConnections List<Property Map>: Elasticsearch connection configuration block.
synonymSetId String: The name of the synonym set. Must be unique within the Elasticsearch cluster.
synonymsSets List<Property Map>: The list of synonym rules for this synonym set.

Supporting Types

ElasticsearchSynonymSetElasticsearchConnection, ElasticsearchSynonymSetElasticsearchConnectionArgs

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.

ElasticsearchSynonymSetSynonymsSet, ElasticsearchSynonymSetSynonymsSetArgs

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. When omitted, the provider generates a UUID.

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. When omitted, the provider generates a UUID.

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. When omitted, the provider generates a UUID.

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. When omitted, the provider generates a UUID.

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. When omitted, the provider generates a UUID.

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

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. When omitted, the provider generates a UUID.

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.ElasticsearchSynonymSet

On this page

On this page

Create ElasticsearchSynonymSet Resource

Constructor syntax

Parameters

Constructor example

ElasticsearchSynonymSet Resource Properties

Inputs

Outputs

Look up Existing ElasticsearchSynonymSet Resource

Supporting Types

ElasticsearchSynonymSetElasticsearchConnection, ElasticsearchSynonymSetElasticsearchConnectionArgs

ElasticsearchSynonymSetSynonymsSet, ElasticsearchSynonymSetSynonymsSetArgs

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

elasticstack.ElasticsearchSynonymSet

On this page

On this page

Create ElasticsearchSynonymSet Resource

Constructor syntax

Parameters

Constructor example

ElasticsearchSynonymSet Resource Properties

Inputs

Outputs

Look up Existing ElasticsearchSynonymSet Resource

Supporting Types

ElasticsearchSynonymSetElasticsearchConnection, ElasticsearchSynonymSetElasticsearchConnectionArgs

ElasticsearchSynonymSetSynonymsSet, ElasticsearchSynonymSetSynonymsSetArgs

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.