Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

getElasticSearch

# Elasticsearch Data Source

The Elasticsearch data source provides information about the existing Aiven Elasticsearch service.

Example Usage

using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var es1 = Output.Create(Aiven.GetElasticSearch.InvokeAsync(new Aiven.GetElasticSearchArgs
        {
            Project = data.Aiven_project.Pr1.Project,
            ServiceName = "my-es1",
        }));
    }

}
package main

import (
    "github.com/pulumi/pulumi-aiven/sdk/v3/go/aiven"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := aiven.LookupElasticSearch(ctx, &aiven.LookupElasticSearchArgs{
            Project:     data.Aiven_project.Pr1.Project,
            ServiceName: "my-es1",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aiven as aiven

es1 = aiven.get_elastic_search(project=data["aiven_project"]["pr1"]["project"],
    service_name="my-es1")
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const es1 = aiven.getElasticSearch({
    project: data.aiven_project.pr1.project,
    serviceName: "my-es1",
});

Using getElasticSearch

function getElasticSearch(args: GetElasticSearchArgs, opts?: InvokeOptions): Promise<GetElasticSearchResult>
def get_elastic_search(cloud_name: Optional[str] = None, components: Optional[Sequence[GetElasticSearchComponentArgs]] = None, elasticsearch: Optional[GetElasticSearchElasticsearchArgs] = None, elasticsearch_user_config: Optional[GetElasticSearchElasticsearchUserConfigArgs] = None, maintenance_window_dow: Optional[str] = None, maintenance_window_time: Optional[str] = None, plan: Optional[str] = None, project: Optional[str] = None, project_vpc_id: Optional[str] = None, service_host: Optional[str] = None, service_integrations: Optional[Sequence[GetElasticSearchServiceIntegrationArgs]] = None, service_name: Optional[str] = None, service_password: Optional[str] = None, service_port: Optional[int] = None, service_type: Optional[str] = None, service_uri: Optional[str] = None, service_username: Optional[str] = None, state: Optional[str] = None, termination_protection: Optional[bool] = None, opts: Optional[InvokeOptions] = None) -> GetElasticSearchResult
func LookupElasticSearch(ctx *Context, args *LookupElasticSearchArgs, opts ...InvokeOption) (*LookupElasticSearchResult, error)

Note: This function is named LookupElasticSearch in the Go SDK.

public static class GetElasticSearch {
    public static Task<GetElasticSearchResult> InvokeAsync(GetElasticSearchArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

ServiceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

CloudName string

defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.

Components List<GetElasticSearchComponentArgs>
Elasticsearch GetElasticSearchElasticsearchArgs

Elasticsearch specific server provided values.

ElasticsearchUserConfig GetElasticSearchElasticsearchUserConfigArgs

defines Elasticsearch specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

ProjectVpcId string

optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceHost string

Elasticsearch hostname.

ServiceIntegrations List<GetElasticSearchServiceIntegrationArgs>
ServicePassword string

Password used for connecting to the Elasticsearch service, if applicable.

ServicePort int

Elasticsearch port.

ServiceType string
ServiceUri string

URI for connecting to the Elasticsearch service.

ServiceUsername string

Username used for connecting to the Elasticsearch service, if applicable.

State string

Service state.

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

ServiceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

CloudName string

defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.

Components []GetElasticSearchComponent
Elasticsearch GetElasticSearchElasticsearch

Elasticsearch specific server provided values.

ElasticsearchUserConfig GetElasticSearchElasticsearchUserConfig

defines Elasticsearch specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

ProjectVpcId string

optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceHost string

Elasticsearch hostname.

ServiceIntegrations []GetElasticSearchServiceIntegration
ServicePassword string

Password used for connecting to the Elasticsearch service, if applicable.

ServicePort int

Elasticsearch port.

ServiceType string
ServiceUri string

URI for connecting to the Elasticsearch service.

ServiceUsername string

Username used for connecting to the Elasticsearch service, if applicable.

State string

Service state.

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

serviceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

cloudName string

defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.

components GetElasticSearchComponent[]
elasticsearch GetElasticSearchElasticsearch

Elasticsearch specific server provided values.

elasticsearchUserConfig GetElasticSearchElasticsearchUserConfig

defines Elasticsearch specific additional configuration options. The following configuration options available:

maintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

projectVpcId string

optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

serviceHost string

Elasticsearch hostname.

serviceIntegrations GetElasticSearchServiceIntegration[]
servicePassword string

Password used for connecting to the Elasticsearch service, if applicable.

servicePort number

Elasticsearch port.

serviceType string
serviceUri string

URI for connecting to the Elasticsearch service.

serviceUsername string

Username used for connecting to the Elasticsearch service, if applicable.

state string

Service state.

terminationProtection boolean

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

project str

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

service_name str

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

cloud_name str

defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.

components Sequence[GetElasticSearchComponentArgs]
elasticsearch GetElasticSearchElasticsearchArgs

Elasticsearch specific server provided values.

elasticsearch_user_config GetElasticSearchElasticsearchUserConfigArgs

defines Elasticsearch specific additional configuration options. The following configuration options available:

maintenance_window_dow str

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenance_window_time str

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan str

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

project_vpc_id str

optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

service_host str

Elasticsearch hostname.

service_integrations Sequence[GetElasticSearchServiceIntegrationArgs]
service_password str

Password used for connecting to the Elasticsearch service, if applicable.

service_port int

Elasticsearch port.

service_type str
service_uri str

URI for connecting to the Elasticsearch service.

service_username str

Username used for connecting to the Elasticsearch service, if applicable.

state str

Service state.

termination_protection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

getElasticSearch Result

The following output properties are available:

Components List<GetElasticSearchComponent>
Elasticsearch GetElasticSearchElasticsearch

Elasticsearch specific server provided values.

Id string

The provider-assigned unique ID for this managed resource.

Project string
ServiceHost string

Elasticsearch hostname.

ServiceName string
ServicePassword string

Password used for connecting to the Elasticsearch service, if applicable.

ServicePort int

Elasticsearch port.

ServiceType string
ServiceUri string

URI for connecting to the Elasticsearch service.

ServiceUsername string

Username used for connecting to the Elasticsearch service, if applicable.

State string

Service state.

CloudName string

defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.

ElasticsearchUserConfig GetElasticSearchElasticsearchUserConfig

defines Elasticsearch specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

ProjectVpcId string

optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceIntegrations List<GetElasticSearchServiceIntegration>
TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Components []GetElasticSearchComponent
Elasticsearch GetElasticSearchElasticsearch

Elasticsearch specific server provided values.

Id string

The provider-assigned unique ID for this managed resource.

Project string
ServiceHost string

Elasticsearch hostname.

ServiceName string
ServicePassword string

Password used for connecting to the Elasticsearch service, if applicable.

ServicePort int

Elasticsearch port.

ServiceType string
ServiceUri string

URI for connecting to the Elasticsearch service.

ServiceUsername string

Username used for connecting to the Elasticsearch service, if applicable.

State string

Service state.

CloudName string

defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.

ElasticsearchUserConfig GetElasticSearchElasticsearchUserConfig

defines Elasticsearch specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

ProjectVpcId string

optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceIntegrations []GetElasticSearchServiceIntegration
TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

components GetElasticSearchComponent[]
elasticsearch GetElasticSearchElasticsearch

Elasticsearch specific server provided values.

id string

The provider-assigned unique ID for this managed resource.

project string
serviceHost string

Elasticsearch hostname.

serviceName string
servicePassword string

Password used for connecting to the Elasticsearch service, if applicable.

servicePort number

Elasticsearch port.

serviceType string
serviceUri string

URI for connecting to the Elasticsearch service.

serviceUsername string

Username used for connecting to the Elasticsearch service, if applicable.

state string

Service state.

cloudName string

defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.

elasticsearchUserConfig GetElasticSearchElasticsearchUserConfig

defines Elasticsearch specific additional configuration options. The following configuration options available:

maintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

projectVpcId string

optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

serviceIntegrations GetElasticSearchServiceIntegration[]
terminationProtection boolean

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

components Sequence[GetElasticSearchComponent]
elasticsearch GetElasticSearchElasticsearch

Elasticsearch specific server provided values.

id str

The provider-assigned unique ID for this managed resource.

project str
service_host str

Elasticsearch hostname.

service_name str
service_password str

Password used for connecting to the Elasticsearch service, if applicable.

service_port int

Elasticsearch port.

service_type str
service_uri str

URI for connecting to the Elasticsearch service.

service_username str

Username used for connecting to the Elasticsearch service, if applicable.

state str

Service state.

cloud_name str

defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (aws, azure, do google, upcloud, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider’s own support articles, like here for Google and here for AWS.

elasticsearch_user_config GetElasticSearchElasticsearchUserConfig

defines Elasticsearch specific additional configuration options. The following configuration options available:

maintenance_window_dow str

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenance_window_time str

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan str

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

project_vpc_id str

optionally specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

service_integrations Sequence[GetElasticSearchServiceIntegration]
termination_protection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Supporting Types

GetElasticSearchComponent

Component string
Host string
KafkaAuthenticationMethod string
Port int
Route string
Ssl bool
Usage string
Component string
Host string
KafkaAuthenticationMethod string
Port int
Route string
Ssl bool
Usage string
component string
host string
kafkaAuthenticationMethod string
port number
route string
ssl boolean
usage string

GetElasticSearchElasticsearch

KibanaUri string

URI for Kibana frontend.

KibanaUri string

URI for Kibana frontend.

kibanaUri string

URI for Kibana frontend.

kibana_uri str

URI for Kibana frontend.

GetElasticSearchElasticsearchUserConfig

CustomDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

DisableReplicationFactorAdjustment string

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: setting this to true increases a risk of data loss in case of virtual machine failure.

Elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearchArgs

Elasticsearch specific server provided values.

ElasticsearchVersion string

Elasticsearch major version.

IndexPatterns List<GetElasticSearchElasticsearchUserConfigIndexPatternArgs>

Glob pattern and number of indexes matching that pattern to be kept.

IndexTemplate GetElasticSearchElasticsearchUserConfigIndexTemplateArgs

Template settings for all new indexe.

IpFilters List<string>

allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

Kibana GetElasticSearchElasticsearchUserConfigKibanaArgs

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

MaxIndexCount string

Maximum number of indexes to keep before deleting the oldest one.

PrivateAccess GetElasticSearchElasticsearchUserConfigPrivateAccessArgs

Allow access to selected service ports from private networks.

ProjectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created.

PublicAccess GetElasticSearchElasticsearchUserConfigPublicAccessArgs

Allow access to selected service ports from the public Internet.

RecoveryBasebackupName string

Name of the basebackup to restore in forked service.

ServiceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

CustomDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

DisableReplicationFactorAdjustment string

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: setting this to true increases a risk of data loss in case of virtual machine failure.

Elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearch

Elasticsearch specific server provided values.

ElasticsearchVersion string

Elasticsearch major version.

IndexPatterns []GetElasticSearchElasticsearchUserConfigIndexPattern

Glob pattern and number of indexes matching that pattern to be kept.

IndexTemplate GetElasticSearchElasticsearchUserConfigIndexTemplate

Template settings for all new indexe.

IpFilters []string

allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

Kibana GetElasticSearchElasticsearchUserConfigKibana

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

MaxIndexCount string

Maximum number of indexes to keep before deleting the oldest one.

PrivateAccess GetElasticSearchElasticsearchUserConfigPrivateAccess

Allow access to selected service ports from private networks.

ProjectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created.

PublicAccess GetElasticSearchElasticsearchUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

RecoveryBasebackupName string

Name of the basebackup to restore in forked service.

ServiceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

customDomain string

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

disableReplicationFactorAdjustment string

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: setting this to true increases a risk of data loss in case of virtual machine failure.

elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearch

Elasticsearch specific server provided values.

elasticsearchVersion string

Elasticsearch major version.

indexPatterns GetElasticSearchElasticsearchUserConfigIndexPattern[]

Glob pattern and number of indexes matching that pattern to be kept.

indexTemplate GetElasticSearchElasticsearchUserConfigIndexTemplate

Template settings for all new indexe.

ipFilters string[]

allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

kibana GetElasticSearchElasticsearchUserConfigKibana

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

maxIndexCount string

Maximum number of indexes to keep before deleting the oldest one.

privateAccess GetElasticSearchElasticsearchUserConfigPrivateAccess

Allow access to selected service ports from private networks.

projectToForkFrom string

Name of another project to fork a service from. This has effect only when a new service is being created.

publicAccess GetElasticSearchElasticsearchUserConfigPublicAccess

Allow access to selected service ports from the public Internet.

recoveryBasebackupName string

Name of the basebackup to restore in forked service.

serviceToForkFrom string

Name of another service to fork from. This has effect only when a new service is being created.

custom_domain str

Serve the web frontend using a custom CNAME pointing to the Aiven DNS name.

disable_replication_factor_adjustment str

Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: setting this to true increases a risk of data loss in case of virtual machine failure.

elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearchArgs

Elasticsearch specific server provided values.

elasticsearch_version str

Elasticsearch major version.

index_patterns Sequence[GetElasticSearchElasticsearchUserConfigIndexPatternArgs]

Glob pattern and number of indexes matching that pattern to be kept.

index_template GetElasticSearchElasticsearchUserConfigIndexTemplateArgs

Template settings for all new indexe.

ip_filters Sequence[str]

allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

kibana GetElasticSearchElasticsearchUserConfigKibanaArgs

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

max_index_count str

Maximum number of indexes to keep before deleting the oldest one.

private_access GetElasticSearchElasticsearchUserConfigPrivateAccessArgs

Allow access to selected service ports from private networks.

project_to_fork_from str

Name of another project to fork a service from. This has effect only when a new service is being created.

public_access GetElasticSearchElasticsearchUserConfigPublicAccessArgs

Allow access to selected service ports from the public Internet.

recovery_basebackup_name str

Name of the basebackup to restore in forked service.

service_to_fork_from str

Name of another service to fork from. This has effect only when a new service is being created.

GetElasticSearchElasticsearchUserConfigElasticsearch

ActionAutoCreateIndexEnabled string

Explicitly allow or block automatic creation of indices. Defaults to true

ActionDestructiveRequiresName string

Require explicit index names when deleting

ClusterMaxShardsPerNode string

Controls the number of shards allowed in the cluster per data node

HttpMaxContentLength string

Maximum content length for HTTP requests to the Elasticsearch HTTP API, in bytes.

HttpMaxHeaderSize string

The max size of allowed headers, in bytes.

HttpMaxInitialLineLength string

The max length of an HTTP URL, in bytes.

IndicesFielddataCacheSize string

Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

IndicesMemoryIndexBufferSize string

Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

IndicesQueriesCacheSize string

Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other Elasticsearch functionality.

IndicesQueryBoolMaxClauseCount string

Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

ReindexRemoteWhitelists List<string>

Whitelisted addresses for reindexing. Changing this value will cause all Elasticsearch instances to restart.

SearchMaxBuckets string

Maximum number of aggregation buckets allowed in a single response. Elasticsearch default value is used when this is not defined.

ThreadPoolAnalyzeQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolAnalyzeSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolForceMergeSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolGetQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolGetSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolIndexQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolIndexSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolSearchQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolSearchSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolSearchThrottledQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolSearchThrottledSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolWriteQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolWriteSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ActionAutoCreateIndexEnabled string

Explicitly allow or block automatic creation of indices. Defaults to true

ActionDestructiveRequiresName string

Require explicit index names when deleting

ClusterMaxShardsPerNode string

Controls the number of shards allowed in the cluster per data node

HttpMaxContentLength string

Maximum content length for HTTP requests to the Elasticsearch HTTP API, in bytes.

HttpMaxHeaderSize string

The max size of allowed headers, in bytes.

HttpMaxInitialLineLength string

The max length of an HTTP URL, in bytes.

IndicesFielddataCacheSize string

Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

IndicesMemoryIndexBufferSize string

Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

IndicesQueriesCacheSize string

Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other Elasticsearch functionality.

IndicesQueryBoolMaxClauseCount string

Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

ReindexRemoteWhitelists []string

Whitelisted addresses for reindexing. Changing this value will cause all Elasticsearch instances to restart.

SearchMaxBuckets string

Maximum number of aggregation buckets allowed in a single response. Elasticsearch default value is used when this is not defined.

ThreadPoolAnalyzeQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolAnalyzeSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolForceMergeSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolGetQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolGetSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolIndexQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolIndexSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolSearchQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolSearchSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolSearchThrottledQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolSearchThrottledSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

ThreadPoolWriteQueueSize string

Size for the thread pool queue. See documentation for exact details.

ThreadPoolWriteSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

actionAutoCreateIndexEnabled string

Explicitly allow or block automatic creation of indices. Defaults to true

actionDestructiveRequiresName string

Require explicit index names when deleting

clusterMaxShardsPerNode string

Controls the number of shards allowed in the cluster per data node

httpMaxContentLength string

Maximum content length for HTTP requests to the Elasticsearch HTTP API, in bytes.

httpMaxHeaderSize string

The max size of allowed headers, in bytes.

httpMaxInitialLineLength string

The max length of an HTTP URL, in bytes.

indicesFielddataCacheSize string

Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

indicesMemoryIndexBufferSize string

Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

indicesQueriesCacheSize string

Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other Elasticsearch functionality.

indicesQueryBoolMaxClauseCount string

Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

reindexRemoteWhitelists string[]

Whitelisted addresses for reindexing. Changing this value will cause all Elasticsearch instances to restart.

searchMaxBuckets string

Maximum number of aggregation buckets allowed in a single response. Elasticsearch default value is used when this is not defined.

threadPoolAnalyzeQueueSize string

Size for the thread pool queue. See documentation for exact details.

threadPoolAnalyzeSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

threadPoolForceMergeSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

threadPoolGetQueueSize string

Size for the thread pool queue. See documentation for exact details.

threadPoolGetSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

threadPoolIndexQueueSize string

Size for the thread pool queue. See documentation for exact details.

threadPoolIndexSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

threadPoolSearchQueueSize string

Size for the thread pool queue. See documentation for exact details.

threadPoolSearchSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

threadPoolSearchThrottledQueueSize string

Size for the thread pool queue. See documentation for exact details.

threadPoolSearchThrottledSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

threadPoolWriteQueueSize string

Size for the thread pool queue. See documentation for exact details.

threadPoolWriteSize string

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

action_auto_create_index_enabled str

Explicitly allow or block automatic creation of indices. Defaults to true

action_destructive_requires_name str

Require explicit index names when deleting

cluster_max_shards_per_node str

Controls the number of shards allowed in the cluster per data node

http_max_content_length str

Maximum content length for HTTP requests to the Elasticsearch HTTP API, in bytes.

http_max_header_size str

The max size of allowed headers, in bytes.

http_max_initial_line_length str

The max length of an HTTP URL, in bytes.

indices_fielddata_cache_size str

Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.

indices_memory_index_buffer_size str

Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.

indices_queries_cache_size str

Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other Elasticsearch functionality.

indices_query_bool_max_clause_count str

Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.

reindex_remote_whitelists Sequence[str]

Whitelisted addresses for reindexing. Changing this value will cause all Elasticsearch instances to restart.

search_max_buckets str

Maximum number of aggregation buckets allowed in a single response. Elasticsearch default value is used when this is not defined.

thread_pool_analyze_queue_size str

Size for the thread pool queue. See documentation for exact details.

thread_pool_analyze_size str

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_force_merge_size str

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_get_queue_size str

Size for the thread pool queue. See documentation for exact details.

thread_pool_get_size str

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_index_queue_size str

Size for the thread pool queue. See documentation for exact details.

thread_pool_index_size str

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_search_queue_size str

Size for the thread pool queue. See documentation for exact details.

thread_pool_search_size str

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_search_throttled_queue_size str

Size for the thread pool queue. See documentation for exact details.

thread_pool_search_throttled_size str

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

thread_pool_write_queue_size str

Size for the thread pool queue. See documentation for exact details.

thread_pool_write_size str

Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.

GetElasticSearchElasticsearchUserConfigIndexPattern

MaxIndexCount string

Maximum number of indexes to keep before deleting the oldest one.

Pattern string

Must consist of alpha-numeric characters, dashes, underscores, dots and glob characters (* and ?)

MaxIndexCount string

Maximum number of indexes to keep before deleting the oldest one.

Pattern string

Must consist of alpha-numeric characters, dashes, underscores, dots and glob characters (* and ?)

maxIndexCount string

Maximum number of indexes to keep before deleting the oldest one.

pattern string

Must consist of alpha-numeric characters, dashes, underscores, dots and glob characters (* and ?)

max_index_count str

Maximum number of indexes to keep before deleting the oldest one.

pattern str

Must consist of alpha-numeric characters, dashes, underscores, dots and glob characters (* and ?)

GetElasticSearchElasticsearchUserConfigIndexTemplate

MappingNestedObjectsLimit string

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

NumberOfReplicas string

The number of replicas each primary shard has.

NumberOfShards string

The number of primary shards that an index should have.

MappingNestedObjectsLimit string

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

NumberOfReplicas string

The number of replicas each primary shard has.

NumberOfShards string

The number of primary shards that an index should have.

mappingNestedObjectsLimit string

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

numberOfReplicas string

The number of replicas each primary shard has.

numberOfShards string

The number of primary shards that an index should have.

mapping_nested_objects_limit str

The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.

number_of_replicas str

The number of replicas each primary shard has.

number_of_shards str

The number of primary shards that an index should have.

GetElasticSearchElasticsearchUserConfigKibana

ElasticsearchRequestTimeout string

Timeout in milliseconds for requests made by Kibana towards Elasticsearch.

Enabled string

Enable or disable Kibana.

MaxOldSpaceSize string

Limits the maximum amount of memory (in MiB) the Kibana process can use. This sets the max_old_space_size option of the nodejs running the Kibana. Note: the memory reserved by Kibana is not available for Elasticsearch.

ElasticsearchRequestTimeout string

Timeout in milliseconds for requests made by Kibana towards Elasticsearch.

Enabled string

Enable or disable Kibana.

MaxOldSpaceSize string

Limits the maximum amount of memory (in MiB) the Kibana process can use. This sets the max_old_space_size option of the nodejs running the Kibana. Note: the memory reserved by Kibana is not available for Elasticsearch.

elasticsearchRequestTimeout string

Timeout in milliseconds for requests made by Kibana towards Elasticsearch.

enabled string

Enable or disable Kibana.

maxOldSpaceSize string

Limits the maximum amount of memory (in MiB) the Kibana process can use. This sets the max_old_space_size option of the nodejs running the Kibana. Note: the memory reserved by Kibana is not available for Elasticsearch.

elasticsearch_request_timeout str

Timeout in milliseconds for requests made by Kibana towards Elasticsearch.

enabled str

Enable or disable Kibana.

max_old_space_size str

Limits the maximum amount of memory (in MiB) the Kibana process can use. This sets the max_old_space_size option of the nodejs running the Kibana. Note: the memory reserved by Kibana is not available for Elasticsearch.

GetElasticSearchElasticsearchUserConfigPrivateAccess

Elasticsearch string

Elasticsearch specific server provided values.

Kibana string

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

Prometheus string

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

Elasticsearch string

Elasticsearch specific server provided values.

Kibana string

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

Prometheus string

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

elasticsearch string

Elasticsearch specific server provided values.

kibana string

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

prometheus string

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

elasticsearch str

Elasticsearch specific server provided values.

kibana str

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

prometheus str

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

GetElasticSearchElasticsearchUserConfigPublicAccess

Elasticsearch string

Elasticsearch specific server provided values.

Kibana string

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

Prometheus string

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

Elasticsearch string

Elasticsearch specific server provided values.

Kibana string

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

Prometheus string

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

elasticsearch string

Elasticsearch specific server provided values.

kibana string

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

prometheus string

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

elasticsearch str

Elasticsearch specific server provided values.

kibana str

Allow clients to connect to kibana from the public internet for service nodes that are in a project VPC or another type of private network.

prometheus str

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

GetElasticSearchServiceIntegration

Package Details

Repository
https://github.com/pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.