published on Monday, Jun 1, 2026 by elastic
published on Monday, Jun 1, 2026 by elastic
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
// Self-managed PostgreSQL connector
const postgres = new elasticstack.ElasticsearchConnector("postgres", {
connectorId: "music-catalog",
serviceType: "postgresql",
name: "music catalog",
description: "Indexes the music catalog database.",
indexName: "search-music",
language: "english",
pipeline: {
name: "search-default-ingestion",
extractBinaryContent: false,
reduceWhitespace: true,
runMlInference: false,
},
scheduling: {
full: {
enabled: true,
interval: "0 0 * * * ?",
},
incremental: {
enabled: false,
interval: "0 0 0 * * ?",
},
accessControl: {
enabled: false,
interval: "0 0 0 * * ?",
},
},
features: {
syncRules: {
basic: {
enabled: true,
},
advanced: {
enabled: false,
},
},
documentLevelSecurity: {
enabled: false,
},
incrementalSync: {
enabled: false,
},
nativeConnectorApiKeys: {
enabled: false,
},
},
});
import pulumi
import pulumi_elasticstack as elasticstack
# Self-managed PostgreSQL connector
postgres = elasticstack.ElasticsearchConnector("postgres",
connector_id="music-catalog",
service_type="postgresql",
name="music catalog",
description="Indexes the music catalog database.",
index_name="search-music",
language="english",
pipeline={
"name": "search-default-ingestion",
"extract_binary_content": False,
"reduce_whitespace": True,
"run_ml_inference": False,
},
scheduling={
"full": {
"enabled": True,
"interval": "0 0 * * * ?",
},
"incremental": {
"enabled": False,
"interval": "0 0 0 * * ?",
},
"access_control": {
"enabled": False,
"interval": "0 0 0 * * ?",
},
},
features={
"sync_rules": {
"basic": {
"enabled": True,
},
"advanced": {
"enabled": False,
},
},
"document_level_security": {
"enabled": False,
},
"incremental_sync": {
"enabled": False,
},
"native_connector_api_keys": {
"enabled": False,
},
})
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 {
// Self-managed PostgreSQL connector
_, err := elasticstack.NewElasticsearchConnector(ctx, "postgres", &elasticstack.ElasticsearchConnectorArgs{
ConnectorId: pulumi.String("music-catalog"),
ServiceType: pulumi.String("postgresql"),
Name: pulumi.String("music catalog"),
Description: pulumi.String("Indexes the music catalog database."),
IndexName: pulumi.String("search-music"),
Language: pulumi.String("english"),
Pipeline: &elasticstack.ElasticsearchConnectorPipelineArgs{
Name: pulumi.String("search-default-ingestion"),
ExtractBinaryContent: pulumi.Bool(false),
ReduceWhitespace: pulumi.Bool(true),
RunMlInference: pulumi.Bool(false),
},
Scheduling: &elasticstack.ElasticsearchConnectorSchedulingArgs{
Full: &elasticstack.ElasticsearchConnectorSchedulingFullArgs{
Enabled: pulumi.Bool(true),
Interval: pulumi.String("0 0 * * * ?"),
},
Incremental: &elasticstack.ElasticsearchConnectorSchedulingIncrementalArgs{
Enabled: pulumi.Bool(false),
Interval: pulumi.String("0 0 0 * * ?"),
},
AccessControl: &elasticstack.ElasticsearchConnectorSchedulingAccessControlArgs{
Enabled: pulumi.Bool(false),
Interval: pulumi.String("0 0 0 * * ?"),
},
},
Features: &elasticstack.ElasticsearchConnectorFeaturesArgs{
SyncRules: &elasticstack.ElasticsearchConnectorFeaturesSyncRulesArgs{
Basic: &elasticstack.ElasticsearchConnectorFeaturesSyncRulesBasicArgs{
Enabled: pulumi.Bool(true),
},
Advanced: &elasticstack.ElasticsearchConnectorFeaturesSyncRulesAdvancedArgs{
Enabled: pulumi.Bool(false),
},
},
DocumentLevelSecurity: &elasticstack.ElasticsearchConnectorFeaturesDocumentLevelSecurityArgs{
Enabled: pulumi.Bool(false),
},
IncrementalSync: &elasticstack.ElasticsearchConnectorFeaturesIncrementalSyncArgs{
Enabled: pulumi.Bool(false),
},
NativeConnectorApiKeys: &elasticstack.ElasticsearchConnectorFeaturesNativeConnectorApiKeysArgs{
Enabled: pulumi.Bool(false),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;
return await Deployment.RunAsync(() =>
{
// Self-managed PostgreSQL connector
var postgres = new Elasticstack.ElasticsearchConnector("postgres", new()
{
ConnectorId = "music-catalog",
ServiceType = "postgresql",
Name = "music catalog",
Description = "Indexes the music catalog database.",
IndexName = "search-music",
Language = "english",
Pipeline = new Elasticstack.Inputs.ElasticsearchConnectorPipelineArgs
{
Name = "search-default-ingestion",
ExtractBinaryContent = false,
ReduceWhitespace = true,
RunMlInference = false,
},
Scheduling = new Elasticstack.Inputs.ElasticsearchConnectorSchedulingArgs
{
Full = new Elasticstack.Inputs.ElasticsearchConnectorSchedulingFullArgs
{
Enabled = true,
Interval = "0 0 * * * ?",
},
Incremental = new Elasticstack.Inputs.ElasticsearchConnectorSchedulingIncrementalArgs
{
Enabled = false,
Interval = "0 0 0 * * ?",
},
AccessControl = new Elasticstack.Inputs.ElasticsearchConnectorSchedulingAccessControlArgs
{
Enabled = false,
Interval = "0 0 0 * * ?",
},
},
Features = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesArgs
{
SyncRules = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesSyncRulesArgs
{
Basic = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesSyncRulesBasicArgs
{
Enabled = true,
},
Advanced = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesSyncRulesAdvancedArgs
{
Enabled = false,
},
},
DocumentLevelSecurity = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesDocumentLevelSecurityArgs
{
Enabled = false,
},
IncrementalSync = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesIncrementalSyncArgs
{
Enabled = false,
},
NativeConnectorApiKeys = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesNativeConnectorApiKeysArgs
{
Enabled = false,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchConnector;
import com.pulumi.elasticstack.ElasticsearchConnectorArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorPipelineArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorSchedulingArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorSchedulingFullArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorSchedulingIncrementalArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorSchedulingAccessControlArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorFeaturesArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorFeaturesSyncRulesArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorFeaturesSyncRulesBasicArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorFeaturesSyncRulesAdvancedArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorFeaturesDocumentLevelSecurityArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorFeaturesIncrementalSyncArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchConnectorFeaturesNativeConnectorApiKeysArgs;
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) {
// Self-managed PostgreSQL connector
var postgres = new ElasticsearchConnector("postgres", ElasticsearchConnectorArgs.builder()
.connectorId("music-catalog")
.serviceType("postgresql")
.name("music catalog")
.description("Indexes the music catalog database.")
.indexName("search-music")
.language("english")
.pipeline(ElasticsearchConnectorPipelineArgs.builder()
.name("search-default-ingestion")
.extractBinaryContent(false)
.reduceWhitespace(true)
.runMlInference(false)
.build())
.scheduling(ElasticsearchConnectorSchedulingArgs.builder()
.full(ElasticsearchConnectorSchedulingFullArgs.builder()
.enabled(true)
.interval("0 0 * * * ?")
.build())
.incremental(ElasticsearchConnectorSchedulingIncrementalArgs.builder()
.enabled(false)
.interval("0 0 0 * * ?")
.build())
.accessControl(ElasticsearchConnectorSchedulingAccessControlArgs.builder()
.enabled(false)
.interval("0 0 0 * * ?")
.build())
.build())
.features(ElasticsearchConnectorFeaturesArgs.builder()
.syncRules(ElasticsearchConnectorFeaturesSyncRulesArgs.builder()
.basic(ElasticsearchConnectorFeaturesSyncRulesBasicArgs.builder()
.enabled(true)
.build())
.advanced(ElasticsearchConnectorFeaturesSyncRulesAdvancedArgs.builder()
.enabled(false)
.build())
.build())
.documentLevelSecurity(ElasticsearchConnectorFeaturesDocumentLevelSecurityArgs.builder()
.enabled(false)
.build())
.incrementalSync(ElasticsearchConnectorFeaturesIncrementalSyncArgs.builder()
.enabled(false)
.build())
.nativeConnectorApiKeys(ElasticsearchConnectorFeaturesNativeConnectorApiKeysArgs.builder()
.enabled(false)
.build())
.build())
.build());
}
}
resources:
# Self-managed PostgreSQL connector
postgres:
type: elasticstack:ElasticsearchConnector
properties:
connectorId: music-catalog
serviceType: postgresql
name: music catalog
description: Indexes the music catalog database.
indexName: search-music
language: english
pipeline:
name: search-default-ingestion
extractBinaryContent: false
reduceWhitespace: true
runMlInference: false
scheduling:
full:
enabled: true
interval: 0 0 * * * ?
incremental:
enabled: false
interval: 0 0 0 * * ?
accessControl:
enabled: false
interval: 0 0 0 * * ?
features:
syncRules:
basic:
enabled: true
advanced:
enabled: false
documentLevelSecurity:
enabled: false
incrementalSync:
enabled: false
nativeConnectorApiKeys:
enabled: false
Example coming soon!
Create ElasticsearchConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ElasticsearchConnector(name: string, args: ElasticsearchConnectorArgs, opts?: CustomResourceOptions);@overload
def ElasticsearchConnector(resource_name: str,
args: ElasticsearchConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ElasticsearchConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
service_type: Optional[str] = None,
features: Optional[ElasticsearchConnectorFeaturesArgs] = None,
configuration_values: Optional[Mapping[str, ElasticsearchConnectorConfigurationValuesArgs]] = None,
connector_id: Optional[str] = None,
description: Optional[str] = None,
elasticsearch_connections: Optional[Sequence[ElasticsearchConnectorElasticsearchConnectionArgs]] = None,
api_key_id: Optional[str] = None,
index_name: Optional[str] = None,
is_native: Optional[bool] = None,
language: Optional[str] = None,
name: Optional[str] = None,
pipeline: Optional[ElasticsearchConnectorPipelineArgs] = None,
scheduling: Optional[ElasticsearchConnectorSchedulingArgs] = None,
api_key_secret_id: Optional[str] = None)func NewElasticsearchConnector(ctx *Context, name string, args ElasticsearchConnectorArgs, opts ...ResourceOption) (*ElasticsearchConnector, error)public ElasticsearchConnector(string name, ElasticsearchConnectorArgs args, CustomResourceOptions? opts = null)
public ElasticsearchConnector(String name, ElasticsearchConnectorArgs args)
public ElasticsearchConnector(String name, ElasticsearchConnectorArgs args, CustomResourceOptions options)
type: elasticstack:ElasticsearchConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "elasticstack_elasticsearchconnector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ElasticsearchConnectorArgs
- 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 ElasticsearchConnectorArgs
- 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 ElasticsearchConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ElasticsearchConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ElasticsearchConnectorArgs
- 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 elasticsearchConnectorResource = new Elasticstack.ElasticsearchConnector("elasticsearchConnectorResource", new()
{
ServiceType = "string",
Features = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesArgs
{
DocumentLevelSecurity = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesDocumentLevelSecurityArgs
{
Enabled = false,
},
IncrementalSync = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesIncrementalSyncArgs
{
Enabled = false,
},
NativeConnectorApiKeys = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesNativeConnectorApiKeysArgs
{
Enabled = false,
},
SyncRules = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesSyncRulesArgs
{
Advanced = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesSyncRulesAdvancedArgs
{
Enabled = false,
},
Basic = new Elasticstack.Inputs.ElasticsearchConnectorFeaturesSyncRulesBasicArgs
{
Enabled = false,
},
},
},
ConfigurationValues =
{
{ "string", new Elasticstack.Inputs.ElasticsearchConnectorConfigurationValuesArgs
{
Bool = false,
Json = "string",
Number = 0,
SecretValue = "string",
String = "string",
} },
},
ConnectorId = "string",
Description = "string",
ElasticsearchConnections = new[]
{
new Elasticstack.Inputs.ElasticsearchConnectorElasticsearchConnectionArgs
{
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",
},
},
ApiKeyId = "string",
IndexName = "string",
IsNative = false,
Language = "string",
Name = "string",
Pipeline = new Elasticstack.Inputs.ElasticsearchConnectorPipelineArgs
{
ExtractBinaryContent = false,
Name = "string",
ReduceWhitespace = false,
RunMlInference = false,
},
Scheduling = new Elasticstack.Inputs.ElasticsearchConnectorSchedulingArgs
{
AccessControl = new Elasticstack.Inputs.ElasticsearchConnectorSchedulingAccessControlArgs
{
Enabled = false,
Interval = "string",
},
Full = new Elasticstack.Inputs.ElasticsearchConnectorSchedulingFullArgs
{
Enabled = false,
Interval = "string",
},
Incremental = new Elasticstack.Inputs.ElasticsearchConnectorSchedulingIncrementalArgs
{
Enabled = false,
Interval = "string",
},
},
ApiKeySecretId = "string",
});
example, err := elasticstack.NewElasticsearchConnector(ctx, "elasticsearchConnectorResource", &elasticstack.ElasticsearchConnectorArgs{
ServiceType: pulumi.String("string"),
Features: &elasticstack.ElasticsearchConnectorFeaturesArgs{
DocumentLevelSecurity: &elasticstack.ElasticsearchConnectorFeaturesDocumentLevelSecurityArgs{
Enabled: pulumi.Bool(false),
},
IncrementalSync: &elasticstack.ElasticsearchConnectorFeaturesIncrementalSyncArgs{
Enabled: pulumi.Bool(false),
},
NativeConnectorApiKeys: &elasticstack.ElasticsearchConnectorFeaturesNativeConnectorApiKeysArgs{
Enabled: pulumi.Bool(false),
},
SyncRules: &elasticstack.ElasticsearchConnectorFeaturesSyncRulesArgs{
Advanced: &elasticstack.ElasticsearchConnectorFeaturesSyncRulesAdvancedArgs{
Enabled: pulumi.Bool(false),
},
Basic: &elasticstack.ElasticsearchConnectorFeaturesSyncRulesBasicArgs{
Enabled: pulumi.Bool(false),
},
},
},
ConfigurationValues: elasticstack.ElasticsearchConnectorConfigurationValuesMap{
"string": &elasticstack.ElasticsearchConnectorConfigurationValuesArgs{
Bool: pulumi.Bool(false),
Json: pulumi.String("string"),
Number: pulumi.Float64(0),
SecretValue: pulumi.String("string"),
String: pulumi.String("string"),
},
},
ConnectorId: pulumi.String("string"),
Description: pulumi.String("string"),
ElasticsearchConnections: elasticstack.ElasticsearchConnectorElasticsearchConnectionArray{
&elasticstack.ElasticsearchConnectorElasticsearchConnectionArgs{
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"),
},
},
ApiKeyId: pulumi.String("string"),
IndexName: pulumi.String("string"),
IsNative: pulumi.Bool(false),
Language: pulumi.String("string"),
Name: pulumi.String("string"),
Pipeline: &elasticstack.ElasticsearchConnectorPipelineArgs{
ExtractBinaryContent: pulumi.Bool(false),
Name: pulumi.String("string"),
ReduceWhitespace: pulumi.Bool(false),
RunMlInference: pulumi.Bool(false),
},
Scheduling: &elasticstack.ElasticsearchConnectorSchedulingArgs{
AccessControl: &elasticstack.ElasticsearchConnectorSchedulingAccessControlArgs{
Enabled: pulumi.Bool(false),
Interval: pulumi.String("string"),
},
Full: &elasticstack.ElasticsearchConnectorSchedulingFullArgs{
Enabled: pulumi.Bool(false),
Interval: pulumi.String("string"),
},
Incremental: &elasticstack.ElasticsearchConnectorSchedulingIncrementalArgs{
Enabled: pulumi.Bool(false),
Interval: pulumi.String("string"),
},
},
ApiKeySecretId: pulumi.String("string"),
})
resource "elasticstack_elasticsearchconnector" "elasticsearchConnectorResource" {
service_type = "string"
features = {
document_level_security = {
enabled = false
}
incremental_sync = {
enabled = false
}
native_connector_api_keys = {
enabled = false
}
sync_rules = {
advanced = {
enabled = false
}
basic = {
enabled = false
}
}
}
configuration_values = {
"string" = {
bool = false
json = "string"
number = 0
secret_value = "string"
string = "string"
}
}
connector_id = "string"
description = "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"
}
api_key_id = "string"
index_name = "string"
is_native = false
language = "string"
name = "string"
pipeline = {
extract_binary_content = false
name = "string"
reduce_whitespace = false
run_ml_inference = false
}
scheduling = {
access_control = {
enabled = false
interval = "string"
}
full = {
enabled = false
interval = "string"
}
incremental = {
enabled = false
interval = "string"
}
}
api_key_secret_id = "string"
}
var elasticsearchConnectorResource = new ElasticsearchConnector("elasticsearchConnectorResource", ElasticsearchConnectorArgs.builder()
.serviceType("string")
.features(ElasticsearchConnectorFeaturesArgs.builder()
.documentLevelSecurity(ElasticsearchConnectorFeaturesDocumentLevelSecurityArgs.builder()
.enabled(false)
.build())
.incrementalSync(ElasticsearchConnectorFeaturesIncrementalSyncArgs.builder()
.enabled(false)
.build())
.nativeConnectorApiKeys(ElasticsearchConnectorFeaturesNativeConnectorApiKeysArgs.builder()
.enabled(false)
.build())
.syncRules(ElasticsearchConnectorFeaturesSyncRulesArgs.builder()
.advanced(ElasticsearchConnectorFeaturesSyncRulesAdvancedArgs.builder()
.enabled(false)
.build())
.basic(ElasticsearchConnectorFeaturesSyncRulesBasicArgs.builder()
.enabled(false)
.build())
.build())
.build())
.configurationValues(Map.of("string", ElasticsearchConnectorConfigurationValuesArgs.builder()
.bool(false)
.json("string")
.number(0.0)
.secretValue("string")
.string("string")
.build()))
.connectorId("string")
.description("string")
.elasticsearchConnections(ElasticsearchConnectorElasticsearchConnectionArgs.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())
.apiKeyId("string")
.indexName("string")
.isNative(false)
.language("string")
.name("string")
.pipeline(ElasticsearchConnectorPipelineArgs.builder()
.extractBinaryContent(false)
.name("string")
.reduceWhitespace(false)
.runMlInference(false)
.build())
.scheduling(ElasticsearchConnectorSchedulingArgs.builder()
.accessControl(ElasticsearchConnectorSchedulingAccessControlArgs.builder()
.enabled(false)
.interval("string")
.build())
.full(ElasticsearchConnectorSchedulingFullArgs.builder()
.enabled(false)
.interval("string")
.build())
.incremental(ElasticsearchConnectorSchedulingIncrementalArgs.builder()
.enabled(false)
.interval("string")
.build())
.build())
.apiKeySecretId("string")
.build());
elasticsearch_connector_resource = elasticstack.ElasticsearchConnector("elasticsearchConnectorResource",
service_type="string",
features={
"document_level_security": {
"enabled": False,
},
"incremental_sync": {
"enabled": False,
},
"native_connector_api_keys": {
"enabled": False,
},
"sync_rules": {
"advanced": {
"enabled": False,
},
"basic": {
"enabled": False,
},
},
},
configuration_values={
"string": {
"bool": False,
"json": "string",
"number": float(0),
"secret_value": "string",
"string": "string",
},
},
connector_id="string",
description="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",
}],
api_key_id="string",
index_name="string",
is_native=False,
language="string",
name="string",
pipeline={
"extract_binary_content": False,
"name": "string",
"reduce_whitespace": False,
"run_ml_inference": False,
},
scheduling={
"access_control": {
"enabled": False,
"interval": "string",
},
"full": {
"enabled": False,
"interval": "string",
},
"incremental": {
"enabled": False,
"interval": "string",
},
},
api_key_secret_id="string")
const elasticsearchConnectorResource = new elasticstack.ElasticsearchConnector("elasticsearchConnectorResource", {
serviceType: "string",
features: {
documentLevelSecurity: {
enabled: false,
},
incrementalSync: {
enabled: false,
},
nativeConnectorApiKeys: {
enabled: false,
},
syncRules: {
advanced: {
enabled: false,
},
basic: {
enabled: false,
},
},
},
configurationValues: {
string: {
bool: false,
json: "string",
number: 0,
secretValue: "string",
string: "string",
},
},
connectorId: "string",
description: "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",
}],
apiKeyId: "string",
indexName: "string",
isNative: false,
language: "string",
name: "string",
pipeline: {
extractBinaryContent: false,
name: "string",
reduceWhitespace: false,
runMlInference: false,
},
scheduling: {
accessControl: {
enabled: false,
interval: "string",
},
full: {
enabled: false,
interval: "string",
},
incremental: {
enabled: false,
interval: "string",
},
},
apiKeySecretId: "string",
});
type: elasticstack:ElasticsearchConnector
properties:
apiKeyId: string
apiKeySecretId: string
configurationValues:
string:
bool: false
json: string
number: 0
secretValue: string
string: string
connectorId: string
description: 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
features:
documentLevelSecurity:
enabled: false
incrementalSync:
enabled: false
nativeConnectorApiKeys:
enabled: false
syncRules:
advanced:
enabled: false
basic:
enabled: false
indexName: string
isNative: false
language: string
name: string
pipeline:
extractBinaryContent: false
name: string
reduceWhitespace: false
runMlInference: false
scheduling:
accessControl:
enabled: false
interval: string
full:
enabled: false
interval: string
incremental:
enabled: false
interval: string
serviceType: string
ElasticsearchConnector 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 ElasticsearchConnector resource accepts the following input properties:
- Service
Type string - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum. - Api
Key stringId - ID of the API key used by the connector service for authorization.
- Api
Key stringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- Configuration
Values Dictionary<string, ElasticsearchConnector Configuration Values Args> - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - Connector
Id string - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- Description string
- Connector description.
- Elasticsearch
Connections List<ElasticsearchConnector Elasticsearch Connection> - Elasticsearch connection configuration block.
- Features
Elasticsearch
Connector Features - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - Index
Name string - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- Is
Native bool - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - Language string
- Analyzer language for the connector index.
- Name string
- Human-readable connector name.
- Pipeline
Elasticsearch
Connector Pipeline - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - Scheduling
Elasticsearch
Connector Scheduling - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling.
- Service
Type string - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum. - Api
Key stringId - ID of the API key used by the connector service for authorization.
- Api
Key stringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- Configuration
Values map[string]ElasticsearchConnector Configuration Values Args - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - Connector
Id string - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- Description string
- Connector description.
- Elasticsearch
Connections []ElasticsearchConnector Elasticsearch Connection Args - Elasticsearch connection configuration block.
- Features
Elasticsearch
Connector Features Args - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - Index
Name string - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- Is
Native bool - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - Language string
- Analyzer language for the connector index.
- Name string
- Human-readable connector name.
- Pipeline
Elasticsearch
Connector Pipeline Args - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - Scheduling
Elasticsearch
Connector Scheduling Args - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling.
- service_
type string - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum. - api_
key_ stringid - ID of the API key used by the connector service for authorization.
- api_
key_ stringsecret_ id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration_
values map(object) - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector_
id string - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description string
- Connector description.
- elasticsearch_
connections list(object) - Elasticsearch connection configuration block.
- features object
- Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index_
name string - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is_
native bool - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language string
- Analyzer language for the connector index.
- name string
- Human-readable connector name.
- pipeline object
- Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling object
- Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling.
- service
Type String - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum. - api
Key StringId - ID of the API key used by the connector service for authorization.
- api
Key StringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration
Values Map<String,ElasticsearchConnector Configuration Values Args> - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector
Id String - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description String
- Connector description.
- elasticsearch
Connections List<ElasticsearchConnector Elasticsearch Connection> - Elasticsearch connection configuration block.
- features
Elasticsearch
Connector Features - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index
Name String - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is
Native Boolean - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language String
- Analyzer language for the connector index.
- name String
- Human-readable connector name.
- pipeline
Elasticsearch
Connector Pipeline - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling
Elasticsearch
Connector Scheduling - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling.
- service
Type string - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum. - api
Key stringId - ID of the API key used by the connector service for authorization.
- api
Key stringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration
Values {[key: string]: ElasticsearchConnector Configuration Values Args} - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector
Id string - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description string
- Connector description.
- elasticsearch
Connections ElasticsearchConnector Elasticsearch Connection[] - Elasticsearch connection configuration block.
- features
Elasticsearch
Connector Features - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index
Name string - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is
Native boolean - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language string
- Analyzer language for the connector index.
- name string
- Human-readable connector name.
- pipeline
Elasticsearch
Connector Pipeline - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling
Elasticsearch
Connector Scheduling - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling.
- service_
type str - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum. - api_
key_ strid - ID of the API key used by the connector service for authorization.
- api_
key_ strsecret_ id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration_
values Mapping[str, ElasticsearchConnector Configuration Values Args] - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector_
id str - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description str
- Connector description.
- elasticsearch_
connections Sequence[ElasticsearchConnector Elasticsearch Connection Args] - Elasticsearch connection configuration block.
- features
Elasticsearch
Connector Features Args - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index_
name str - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is_
native bool - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language str
- Analyzer language for the connector index.
- name str
- Human-readable connector name.
- pipeline
Elasticsearch
Connector Pipeline Args - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling
Elasticsearch
Connector Scheduling Args - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling.
- service
Type String - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum. - api
Key StringId - ID of the API key used by the connector service for authorization.
- api
Key StringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration
Values Map<Property Map> - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector
Id String - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description String
- Connector description.
- elasticsearch
Connections List<Property Map> - Elasticsearch connection configuration block.
- features Property Map
- Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index
Name String - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is
Native Boolean - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language String
- Analyzer language for the connector index.
- name String
- Human-readable connector name.
- pipeline Property Map
- Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling Property Map
- Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling.
Outputs
All input properties are implicitly available as output properties. Additionally, the ElasticsearchConnector 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 ElasticsearchConnector Resource
Get an existing ElasticsearchConnector 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?: ElasticsearchConnectorState, opts?: CustomResourceOptions): ElasticsearchConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_key_id: Optional[str] = None,
api_key_secret_id: Optional[str] = None,
configuration_values: Optional[Mapping[str, ElasticsearchConnectorConfigurationValuesArgs]] = None,
connector_id: Optional[str] = None,
description: Optional[str] = None,
elasticsearch_connections: Optional[Sequence[ElasticsearchConnectorElasticsearchConnectionArgs]] = None,
features: Optional[ElasticsearchConnectorFeaturesArgs] = None,
index_name: Optional[str] = None,
is_native: Optional[bool] = None,
language: Optional[str] = None,
name: Optional[str] = None,
pipeline: Optional[ElasticsearchConnectorPipelineArgs] = None,
scheduling: Optional[ElasticsearchConnectorSchedulingArgs] = None,
service_type: Optional[str] = None) -> ElasticsearchConnectorfunc GetElasticsearchConnector(ctx *Context, name string, id IDInput, state *ElasticsearchConnectorState, opts ...ResourceOption) (*ElasticsearchConnector, error)public static ElasticsearchConnector Get(string name, Input<string> id, ElasticsearchConnectorState? state, CustomResourceOptions? opts = null)public static ElasticsearchConnector get(String name, Output<String> id, ElasticsearchConnectorState state, CustomResourceOptions options)resources: _: type: elasticstack:ElasticsearchConnector get: id: ${id}import {
to = elasticstack_elasticsearchconnector.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.
- Api
Key stringId - ID of the API key used by the connector service for authorization.
- Api
Key stringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- Configuration
Values Dictionary<string, ElasticsearchConnector Configuration Values Args> - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - Connector
Id string - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- Description string
- Connector description.
- Elasticsearch
Connections List<ElasticsearchConnector Elasticsearch Connection> - Elasticsearch connection configuration block.
- Features
Elasticsearch
Connector Features - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - Index
Name string - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- Is
Native bool - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - Language string
- Analyzer language for the connector index.
- Name string
- Human-readable connector name.
- Pipeline
Elasticsearch
Connector Pipeline - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - Scheduling
Elasticsearch
Connector Scheduling - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling. - Service
Type string - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum.
- Api
Key stringId - ID of the API key used by the connector service for authorization.
- Api
Key stringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- Configuration
Values map[string]ElasticsearchConnector Configuration Values Args - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - Connector
Id string - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- Description string
- Connector description.
- Elasticsearch
Connections []ElasticsearchConnector Elasticsearch Connection Args - Elasticsearch connection configuration block.
- Features
Elasticsearch
Connector Features Args - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - Index
Name string - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- Is
Native bool - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - Language string
- Analyzer language for the connector index.
- Name string
- Human-readable connector name.
- Pipeline
Elasticsearch
Connector Pipeline Args - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - Scheduling
Elasticsearch
Connector Scheduling Args - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling. - Service
Type string - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum.
- api_
key_ stringid - ID of the API key used by the connector service for authorization.
- api_
key_ stringsecret_ id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration_
values map(object) - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector_
id string - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description string
- Connector description.
- elasticsearch_
connections list(object) - Elasticsearch connection configuration block.
- features object
- Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index_
name string - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is_
native bool - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language string
- Analyzer language for the connector index.
- name string
- Human-readable connector name.
- pipeline object
- Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling object
- Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling. - service_
type string - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum.
- api
Key StringId - ID of the API key used by the connector service for authorization.
- api
Key StringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration
Values Map<String,ElasticsearchConnector Configuration Values Args> - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector
Id String - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description String
- Connector description.
- elasticsearch
Connections List<ElasticsearchConnector Elasticsearch Connection> - Elasticsearch connection configuration block.
- features
Elasticsearch
Connector Features - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index
Name String - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is
Native Boolean - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language String
- Analyzer language for the connector index.
- name String
- Human-readable connector name.
- pipeline
Elasticsearch
Connector Pipeline - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling
Elasticsearch
Connector Scheduling - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling. - service
Type String - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum.
- api
Key stringId - ID of the API key used by the connector service for authorization.
- api
Key stringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration
Values {[key: string]: ElasticsearchConnector Configuration Values Args} - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector
Id string - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description string
- Connector description.
- elasticsearch
Connections ElasticsearchConnector Elasticsearch Connection[] - Elasticsearch connection configuration block.
- features
Elasticsearch
Connector Features - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index
Name string - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is
Native boolean - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language string
- Analyzer language for the connector index.
- name string
- Human-readable connector name.
- pipeline
Elasticsearch
Connector Pipeline - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling
Elasticsearch
Connector Scheduling - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling. - service
Type string - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum.
- api_
key_ strid - ID of the API key used by the connector service for authorization.
- api_
key_ strsecret_ id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration_
values Mapping[str, ElasticsearchConnector Configuration Values Args] - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector_
id str - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description str
- Connector description.
- elasticsearch_
connections Sequence[ElasticsearchConnector Elasticsearch Connection Args] - Elasticsearch connection configuration block.
- features
Elasticsearch
Connector Features Args - Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index_
name str - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is_
native bool - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language str
- Analyzer language for the connector index.
- name str
- Human-readable connector name.
- pipeline
Elasticsearch
Connector Pipeline Args - Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling
Elasticsearch
Connector Scheduling Args - Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling. - service_
type str - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum.
- api
Key StringId - ID of the API key used by the connector service for authorization.
- api
Key StringSecret Id - ID of the connector secret holding the API key (Elastic-managed connectors only).
- configuration
Values Map<Property Map> - User-supplied connector configuration values keyed by field name. Each element must set exactly one of
string,number,bool,json, orsecret_value. Removing a key stops managing it but does not unset the value server-side. - connector
Id String - Unique connector identifier. When omitted, Elasticsearch auto-generates an ID on create.
- description String
- Connector description.
- elasticsearch
Connections List<Property Map> - Elasticsearch connection configuration block.
- features Property Map
- Connector feature flags. Changes trigger
PUT /_connector/{id}/_features. - index
Name String - Destination Elasticsearch index name. When omitted, Elasticsearch may assign a default on create.
- is
Native Boolean - Whether this is an Elastic-managed connector (
true) or self-managed (false). Defaults tofalseon the Elasticsearch side when omitted. - language String
- Analyzer language for the connector index.
- name String
- Human-readable connector name.
- pipeline Property Map
- Ingest pipeline settings applied to synced documents. Changes trigger
PUT /_connector/{id}/_pipeline. - scheduling Property Map
- Sync scheduling for full, incremental, and access-control jobs. Changes trigger
PUT /_connector/{id}/_scheduling. - service
Type String - Connector service type (for example
postgresql,mysql,github). New service types may be added over time; the provider does not validate against a fixed enum.
Supporting Types
ElasticsearchConnectorConfigurationValues, ElasticsearchConnectorConfigurationValuesArgs
- Bool bool
- Boolean configuration value.
- Json string
- JSON-encoded object or array configuration value.
- Number double
- Numeric configuration value (integer or float).
- Secret
Value string - Write-only secret configuration value. Drift is detected via private-state hashing (see resource documentation).
- String string
- String configuration value.
- Bool bool
- Boolean configuration value.
- Json string
- JSON-encoded object or array configuration value.
- Number float64
- Numeric configuration value (integer or float).
- Secret
Value string - Write-only secret configuration value. Drift is detected via private-state hashing (see resource documentation).
- String string
- String configuration value.
- bool bool
- Boolean configuration value.
- json string
- JSON-encoded object or array configuration value.
- number number
- Numeric configuration value (integer or float).
- secret_
value string - Write-only secret configuration value. Drift is detected via private-state hashing (see resource documentation).
- string string
- String configuration value.
- bool Boolean
- Boolean configuration value.
- json String
- JSON-encoded object or array configuration value.
- number Double
- Numeric configuration value (integer or float).
- secret
Value String - Write-only secret configuration value. Drift is detected via private-state hashing (see resource documentation).
- string String
- String configuration value.
- bool boolean
- Boolean configuration value.
- json string
- JSON-encoded object or array configuration value.
- number number
- Numeric configuration value (integer or float).
- secret
Value string - Write-only secret configuration value. Drift is detected via private-state hashing (see resource documentation).
- string string
- String configuration value.
- bool bool
- Boolean configuration value.
- json str
- JSON-encoded object or array configuration value.
- number float
- Numeric configuration value (integer or float).
- secret_
value str - Write-only secret configuration value. Drift is detected via private-state hashing (see resource documentation).
- string str
- String configuration value.
- bool Boolean
- Boolean configuration value.
- json String
- JSON-encoded object or array configuration value.
- number Number
- Numeric configuration value (integer or float).
- secret
Value String - Write-only secret configuration value. Drift is detected via private-state hashing (see resource documentation).
- string String
- String configuration value.
ElasticsearchConnectorElasticsearchConnection, ElasticsearchConnectorElasticsearchConnectionArgs
- 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
- Headers Dictionary<string, 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.
- 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
- Headers map[string]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.
- 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
- 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.
- 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
- headers Map<String,String>
- A list of headers to be sent with each request to Elasticsearch.
- 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
- headers {[key: string]: string}
- A list of headers to be sent with each request to Elasticsearch.
- 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
- 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.
- 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
- headers Map<String>
- A list of headers to be sent with each request to Elasticsearch.
- 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.
ElasticsearchConnectorFeatures, ElasticsearchConnectorFeaturesArgs
- Document
Level ElasticsearchSecurity Connector Features Document Level Security - Feature flag for
document_level_security. - Incremental
Sync ElasticsearchConnector Features Incremental Sync - Feature flag for
incremental_sync. - Native
Connector ElasticsearchApi Keys Connector Features Native Connector Api Keys - Feature flag for
native_connector_api_keys. - Sync
Rules ElasticsearchConnector Features Sync Rules - Sync rules feature flags.
- Document
Level ElasticsearchSecurity Connector Features Document Level Security - Feature flag for
document_level_security. - Incremental
Sync ElasticsearchConnector Features Incremental Sync - Feature flag for
incremental_sync. - Native
Connector ElasticsearchApi Keys Connector Features Native Connector Api Keys - Feature flag for
native_connector_api_keys. - Sync
Rules ElasticsearchConnector Features Sync Rules - Sync rules feature flags.
- document_
level_ objectsecurity - Feature flag for
document_level_security. - incremental_
sync object - Feature flag for
incremental_sync. - native_
connector_ objectapi_ keys - Feature flag for
native_connector_api_keys. - sync_
rules object - Sync rules feature flags.
- document
Level ElasticsearchSecurity Connector Features Document Level Security - Feature flag for
document_level_security. - incremental
Sync ElasticsearchConnector Features Incremental Sync - Feature flag for
incremental_sync. - native
Connector ElasticsearchApi Keys Connector Features Native Connector Api Keys - Feature flag for
native_connector_api_keys. - sync
Rules ElasticsearchConnector Features Sync Rules - Sync rules feature flags.
- document
Level ElasticsearchSecurity Connector Features Document Level Security - Feature flag for
document_level_security. - incremental
Sync ElasticsearchConnector Features Incremental Sync - Feature flag for
incremental_sync. - native
Connector ElasticsearchApi Keys Connector Features Native Connector Api Keys - Feature flag for
native_connector_api_keys. - sync
Rules ElasticsearchConnector Features Sync Rules - Sync rules feature flags.
- document_
level_ Elasticsearchsecurity Connector Features Document Level Security - Feature flag for
document_level_security. - incremental_
sync ElasticsearchConnector Features Incremental Sync - Feature flag for
incremental_sync. - native_
connector_ Elasticsearchapi_ keys Connector Features Native Connector Api Keys - Feature flag for
native_connector_api_keys. - sync_
rules ElasticsearchConnector Features Sync Rules - Sync rules feature flags.
- document
Level Property MapSecurity - Feature flag for
document_level_security. - incremental
Sync Property Map - Feature flag for
incremental_sync. - native
Connector Property MapApi Keys - Feature flag for
native_connector_api_keys. - sync
Rules Property Map - Sync rules feature flags.
ElasticsearchConnectorFeaturesDocumentLevelSecurity, ElasticsearchConnectorFeaturesDocumentLevelSecurityArgs
- Enabled bool
- Whether the feature is enabled.
- Enabled bool
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
- enabled boolean
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
ElasticsearchConnectorFeaturesIncrementalSync, ElasticsearchConnectorFeaturesIncrementalSyncArgs
- Enabled bool
- Whether the feature is enabled.
- Enabled bool
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
- enabled boolean
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
ElasticsearchConnectorFeaturesNativeConnectorApiKeys, ElasticsearchConnectorFeaturesNativeConnectorApiKeysArgs
- Enabled bool
- Whether the feature is enabled.
- Enabled bool
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
- enabled boolean
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
ElasticsearchConnectorFeaturesSyncRules, ElasticsearchConnectorFeaturesSyncRulesArgs
- Advanced
Elasticsearch
Connector Features Sync Rules Advanced - Feature flag for
advanced. - Basic
Elasticsearch
Connector Features Sync Rules Basic - Feature flag for
basic.
- Advanced
Elasticsearch
Connector Features Sync Rules Advanced - Feature flag for
advanced. - Basic
Elasticsearch
Connector Features Sync Rules Basic - Feature flag for
basic.
- advanced
Elasticsearch
Connector Features Sync Rules Advanced - Feature flag for
advanced. - basic
Elasticsearch
Connector Features Sync Rules Basic - Feature flag for
basic.
- advanced
Elasticsearch
Connector Features Sync Rules Advanced - Feature flag for
advanced. - basic
Elasticsearch
Connector Features Sync Rules Basic - Feature flag for
basic.
- advanced
Elasticsearch
Connector Features Sync Rules Advanced - Feature flag for
advanced. - basic
Elasticsearch
Connector Features Sync Rules Basic - Feature flag for
basic.
- advanced Property Map
- Feature flag for
advanced. - basic Property Map
- Feature flag for
basic.
ElasticsearchConnectorFeaturesSyncRulesAdvanced, ElasticsearchConnectorFeaturesSyncRulesAdvancedArgs
- Enabled bool
- Whether the feature is enabled.
- Enabled bool
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
- enabled boolean
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
ElasticsearchConnectorFeaturesSyncRulesBasic, ElasticsearchConnectorFeaturesSyncRulesBasicArgs
- Enabled bool
- Whether the feature is enabled.
- Enabled bool
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
- enabled boolean
- Whether the feature is enabled.
- enabled bool
- Whether the feature is enabled.
- enabled Boolean
- Whether the feature is enabled.
ElasticsearchConnectorPipeline, ElasticsearchConnectorPipelineArgs
- Extract
Binary boolContent - Whether to extract binary content during ingestion.
- Name string
- Ingest pipeline name.
- Reduce
Whitespace bool - Whether to reduce whitespace in extracted text.
- Run
Ml boolInference - Whether to run ML inference during ingestion.
- Extract
Binary boolContent - Whether to extract binary content during ingestion.
- Name string
- Ingest pipeline name.
- Reduce
Whitespace bool - Whether to reduce whitespace in extracted text.
- Run
Ml boolInference - Whether to run ML inference during ingestion.
- extract_
binary_ boolcontent - Whether to extract binary content during ingestion.
- name string
- Ingest pipeline name.
- reduce_
whitespace bool - Whether to reduce whitespace in extracted text.
- run_
ml_ boolinference - Whether to run ML inference during ingestion.
- extract
Binary BooleanContent - Whether to extract binary content during ingestion.
- name String
- Ingest pipeline name.
- reduce
Whitespace Boolean - Whether to reduce whitespace in extracted text.
- run
Ml BooleanInference - Whether to run ML inference during ingestion.
- extract
Binary booleanContent - Whether to extract binary content during ingestion.
- name string
- Ingest pipeline name.
- reduce
Whitespace boolean - Whether to reduce whitespace in extracted text.
- run
Ml booleanInference - Whether to run ML inference during ingestion.
- extract_
binary_ boolcontent - Whether to extract binary content during ingestion.
- name str
- Ingest pipeline name.
- reduce_
whitespace bool - Whether to reduce whitespace in extracted text.
- run_
ml_ boolinference - Whether to run ML inference during ingestion.
- extract
Binary BooleanContent - Whether to extract binary content during ingestion.
- name String
- Ingest pipeline name.
- reduce
Whitespace Boolean - Whether to reduce whitespace in extracted text.
- run
Ml BooleanInference - Whether to run ML inference during ingestion.
ElasticsearchConnectorScheduling, ElasticsearchConnectorSchedulingArgs
- Access
Control ElasticsearchConnector Scheduling Access Control - Schedule for the
access_controlsync job type. - Full
Elasticsearch
Connector Scheduling Full - Schedule for the
fullsync job type. - Incremental
Elasticsearch
Connector Scheduling Incremental - Schedule for the
incrementalsync job type.
- Access
Control ElasticsearchConnector Scheduling Access Control - Schedule for the
access_controlsync job type. - Full
Elasticsearch
Connector Scheduling Full - Schedule for the
fullsync job type. - Incremental
Elasticsearch
Connector Scheduling Incremental - Schedule for the
incrementalsync job type.
- access_
control object - Schedule for the
access_controlsync job type. - full object
- Schedule for the
fullsync job type. - incremental object
- Schedule for the
incrementalsync job type.
- access
Control ElasticsearchConnector Scheduling Access Control - Schedule for the
access_controlsync job type. - full
Elasticsearch
Connector Scheduling Full - Schedule for the
fullsync job type. - incremental
Elasticsearch
Connector Scheduling Incremental - Schedule for the
incrementalsync job type.
- access
Control ElasticsearchConnector Scheduling Access Control - Schedule for the
access_controlsync job type. - full
Elasticsearch
Connector Scheduling Full - Schedule for the
fullsync job type. - incremental
Elasticsearch
Connector Scheduling Incremental - Schedule for the
incrementalsync job type.
- access_
control ElasticsearchConnector Scheduling Access Control - Schedule for the
access_controlsync job type. - full
Elasticsearch
Connector Scheduling Full - Schedule for the
fullsync job type. - incremental
Elasticsearch
Connector Scheduling Incremental - Schedule for the
incrementalsync job type.
- access
Control Property Map - Schedule for the
access_controlsync job type. - full Property Map
- Schedule for the
fullsync job type. - incremental Property Map
- Schedule for the
incrementalsync job type.
ElasticsearchConnectorSchedulingAccessControl, ElasticsearchConnectorSchedulingAccessControlArgs
ElasticsearchConnectorSchedulingFull, ElasticsearchConnectorSchedulingFullArgs
ElasticsearchConnectorSchedulingIncremental, ElasticsearchConnectorSchedulingIncrementalArgs
Import
The pulumi import command can be used, for example:
Import using the bare connector ID
$ pulumi import elasticstack:index/elasticsearchConnector:ElasticsearchConnector postgres music-catalog
Or using the composite ID
$ pulumi import elasticstack:index/elasticsearchConnector:ElasticsearchConnector postgres <cluster_uuid>/music-catalog
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
elasticstackTerraform Provider.
published on Monday, Jun 1, 2026 by elastic