1. Packages
  2. Aiven Provider
  3. API Docs
  4. getElasticSearch
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v4.5.2 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    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/v4/go/aiven"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := aiven.LookupElasticSearch(ctx, &GetElasticSearchArgs{
    			Project:     data.Aiven_project.Pr1.Project,
    			ServiceName: "my-es1",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    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",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    es1 = aiven.get_elastic_search(project=data["aiven_project"]["pr1"]["project"],
        service_name="my-es1")
    

    Example coming soon!

    Using getElasticSearch

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

    function getElasticSearch(args: GetElasticSearchArgs, opts?: InvokeOptions): Promise<GetElasticSearchResult>
    function getElasticSearchOutput(args: GetElasticSearchOutputArgs, opts?: InvokeOptions): Output<GetElasticSearchResult>
    def get_elastic_search(project: Optional[str] = None,
                           service_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetElasticSearchResult
    def get_elastic_search_output(project: Optional[pulumi.Input[str]] = None,
                           service_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetElasticSearchResult]
    func LookupElasticSearch(ctx *Context, args *LookupElasticSearchArgs, opts ...InvokeOption) (*LookupElasticSearchResult, error)
    func LookupElasticSearchOutput(ctx *Context, args *LookupElasticSearchOutputArgs, opts ...InvokeOption) LookupElasticSearchResultOutput

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

    public static class GetElasticSearch 
    {
        public static Task<GetElasticSearchResult> InvokeAsync(GetElasticSearchArgs args, InvokeOptions? opts = null)
        public static Output<GetElasticSearchResult> Invoke(GetElasticSearchInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetElasticSearchResult> getElasticSearch(GetElasticSearchArgs args, InvokeOptions options)
    public static Output<GetElasticSearchResult> getElasticSearch(GetElasticSearchArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getElasticSearch:getElasticSearch
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    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.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    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.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    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.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    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.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    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.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    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.

    getElasticSearch Result

    The following output properties are available:

    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<GetElasticSearchComponent>
    Service component information objects
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    DiskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    DiskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    DiskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    DiskSpaceUsed string
    Disk space that service is currently using
    ElasticsearchUserConfigs List<GetElasticSearchElasticsearchUserConfig>
    Elasticsearch user configurable settings
    Elasticsearches List<GetElasticSearchElasticsearch>
    Elasticsearch server provided values
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One 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 available options can be seem from the Aiven pricing page.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ProjectVpcId string
    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 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
    The hostname of the service.
    ServiceIntegrations List<GetElasticSearchServiceIntegration>
    Service integrations to specify when creating a service. Not applied after initial service creation
    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.
    ServicePassword string
    Password used for connecting to the service, if applicable
    ServicePort int
    The port of the service
    ServiceType string
    Aiven internal service type code
    ServiceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    ServiceUsername string
    Username used for connecting to the service, if applicable
    State string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    StaticIps List<string>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    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.
    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
    Service component information objects
    DiskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    DiskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    DiskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    DiskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    DiskSpaceUsed string
    Disk space that service is currently using
    ElasticsearchUserConfigs []GetElasticSearchElasticsearchUserConfig
    Elasticsearch user configurable settings
    Elasticsearches []GetElasticSearchElasticsearch
    Elasticsearch server provided values
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One 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 available options can be seem from the Aiven pricing page.
    Project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    ProjectVpcId string
    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 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
    The hostname of the service.
    ServiceIntegrations []GetElasticSearchServiceIntegration
    Service integrations to specify when creating a service. Not applied after initial service creation
    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.
    ServicePassword string
    Password used for connecting to the service, if applicable
    ServicePort int
    The port of the service
    ServiceType string
    Aiven internal service type code
    ServiceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    ServiceUsername string
    Username used for connecting to the service, if applicable
    State string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    StaticIps []string
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    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.
    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<GetElasticSearchComponent>
    Service component information objects
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    diskSpaceCap String
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault String
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep String
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed String
    Disk space that service is currently using
    elasticsearchUserConfigs List<GetElasticSearchElasticsearchUserConfig>
    Elasticsearch user configurable settings
    elasticsearches List<GetElasticSearchElasticsearch>
    Elasticsearch server provided values
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One 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 available options can be seem from the Aiven pricing page.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    projectVpcId String
    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 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
    The hostname of the service.
    serviceIntegrations List<GetElasticSearchServiceIntegration>
    Service integrations to specify when creating a service. Not applied after initial service creation
    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.
    servicePassword String
    Password used for connecting to the service, if applicable
    servicePort Integer
    The port of the service
    serviceType String
    Aiven internal service type code
    serviceUri String
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername String
    Username used for connecting to the service, if applicable
    state String
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps List<String>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    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.
    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[]
    Service component information objects
    diskSpace string
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    diskSpaceCap string
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault string
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep string
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed string
    Disk space that service is currently using
    elasticsearchUserConfigs GetElasticSearchElasticsearchUserConfig[]
    Elasticsearch user configurable settings
    elasticsearches GetElasticSearchElasticsearch[]
    Elasticsearch server provided values
    id string
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow string
    Day of week when maintenance operations should be performed. One 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 available options can be seem from the Aiven pricing page.
    project string
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    projectVpcId string
    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 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
    The hostname of the service.
    serviceIntegrations GetElasticSearchServiceIntegration[]
    Service integrations to specify when creating a service. Not applied after initial service creation
    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.
    servicePassword string
    Password used for connecting to the service, if applicable
    servicePort number
    The port of the service
    serviceType string
    Aiven internal service type code
    serviceUri string
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername string
    Username used for connecting to the service, if applicable
    state string
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps string[]
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    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.
    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[GetElasticSearchComponent]
    Service component information objects
    disk_space str
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    disk_space_cap str
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    disk_space_default str
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    disk_space_step str
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    disk_space_used str
    Disk space that service is currently using
    elasticsearch_user_configs Sequence[GetElasticSearchElasticsearchUserConfig]
    Elasticsearch user configurable settings
    elasticsearches Sequence[GetElasticSearchElasticsearch]
    Elasticsearch server provided values
    id str
    The provider-assigned unique ID for this managed resource.
    maintenance_window_dow str
    Day of week when maintenance operations should be performed. One 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 available options can be seem from the Aiven pricing page.
    project str
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    project_vpc_id str
    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 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
    The hostname of the service.
    service_integrations Sequence[GetElasticSearchServiceIntegration]
    Service integrations to specify when creating a service. Not applied after initial service creation
    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.
    service_password str
    Password used for connecting to the service, if applicable
    service_port int
    The port of the service
    service_type str
    Aiven internal service type code
    service_uri str
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    service_username str
    Username used for connecting to the service, if applicable
    state str
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    static_ips Sequence[str]
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    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.
    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<Property Map>
    Service component information objects
    diskSpace String
    The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service rebalancing.
    diskSpaceCap String
    The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
    diskSpaceDefault String
    The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
    diskSpaceStep String
    The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
    diskSpaceUsed String
    Disk space that service is currently using
    elasticsearchUserConfigs List<Property Map>
    Elasticsearch user configurable settings
    elasticsearches List<Property Map>
    Elasticsearch server provided values
    id String
    The provider-assigned unique ID for this managed resource.
    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One 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 available options can be seem from the Aiven pricing page.
    project String
    Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
    projectVpcId String
    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 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
    The hostname of the service.
    serviceIntegrations List<Property Map>
    Service integrations to specify when creating a service. Not applied after initial service creation
    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.
    servicePassword String
    Password used for connecting to the service, if applicable
    servicePort Number
    The port of the service
    serviceType String
    Aiven internal service type code
    serviceUri String
    URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
    serviceUsername String
    Username used for connecting to the service, if applicable
    state String
    Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING
    staticIps List<String>
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    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.

    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 Integer
    route String
    ssl Boolean
    usage String
    component string
    host string
    kafkaAuthenticationMethod string
    port number
    route string
    ssl boolean
    usage string
    component String
    host String
    kafkaAuthenticationMethod String
    port Number
    route String
    ssl Boolean
    usage String

    GetElasticSearchElasticsearch

    KibanaUri string
    KibanaUri string
    kibanaUri String
    kibanaUri string
    kibanaUri String

    GetElasticSearchElasticsearchUserConfig

    CustomDomain string
    DisableReplicationFactorAdjustment string
    Elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearch
    Elasticsearch server provided values
    ElasticsearchVersion string
    IndexPatterns List<GetElasticSearchElasticsearchUserConfigIndexPattern>
    IndexTemplate GetElasticSearchElasticsearchUserConfigIndexTemplate
    IpFilters List<string>
    KeepIndexRefreshInterval string
    Kibana GetElasticSearchElasticsearchUserConfigKibana
    MaxIndexCount string
    OpensearchVersion string
    PrivateAccess GetElasticSearchElasticsearchUserConfigPrivateAccess
    PrivatelinkAccess GetElasticSearchElasticsearchUserConfigPrivatelinkAccess
    ProjectToForkFrom string
    PublicAccess GetElasticSearchElasticsearchUserConfigPublicAccess
    RecoveryBasebackupName string
    ServiceToForkFrom string
    StaticIps string
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    CustomDomain string
    DisableReplicationFactorAdjustment string
    Elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearch
    Elasticsearch server provided values
    ElasticsearchVersion string
    IndexPatterns []GetElasticSearchElasticsearchUserConfigIndexPattern
    IndexTemplate GetElasticSearchElasticsearchUserConfigIndexTemplate
    IpFilters []string
    KeepIndexRefreshInterval string
    Kibana GetElasticSearchElasticsearchUserConfigKibana
    MaxIndexCount string
    OpensearchVersion string
    PrivateAccess GetElasticSearchElasticsearchUserConfigPrivateAccess
    PrivatelinkAccess GetElasticSearchElasticsearchUserConfigPrivatelinkAccess
    ProjectToForkFrom string
    PublicAccess GetElasticSearchElasticsearchUserConfigPublicAccess
    RecoveryBasebackupName string
    ServiceToForkFrom string
    StaticIps string
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    customDomain String
    disableReplicationFactorAdjustment String
    elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearch
    Elasticsearch server provided values
    elasticsearchVersion String
    indexPatterns List<GetElasticSearchElasticsearchUserConfigIndexPattern>
    indexTemplate GetElasticSearchElasticsearchUserConfigIndexTemplate
    ipFilters List<String>
    keepIndexRefreshInterval String
    kibana GetElasticSearchElasticsearchUserConfigKibana
    maxIndexCount String
    opensearchVersion String
    privateAccess GetElasticSearchElasticsearchUserConfigPrivateAccess
    privatelinkAccess GetElasticSearchElasticsearchUserConfigPrivatelinkAccess
    projectToForkFrom String
    publicAccess GetElasticSearchElasticsearchUserConfigPublicAccess
    recoveryBasebackupName String
    serviceToForkFrom String
    staticIps String
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    customDomain string
    disableReplicationFactorAdjustment string
    elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearch
    Elasticsearch server provided values
    elasticsearchVersion string
    indexPatterns GetElasticSearchElasticsearchUserConfigIndexPattern[]
    indexTemplate GetElasticSearchElasticsearchUserConfigIndexTemplate
    ipFilters string[]
    keepIndexRefreshInterval string
    kibana GetElasticSearchElasticsearchUserConfigKibana
    maxIndexCount string
    opensearchVersion string
    privateAccess GetElasticSearchElasticsearchUserConfigPrivateAccess
    privatelinkAccess GetElasticSearchElasticsearchUserConfigPrivatelinkAccess
    projectToForkFrom string
    publicAccess GetElasticSearchElasticsearchUserConfigPublicAccess
    recoveryBasebackupName string
    serviceToForkFrom string
    staticIps string
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    custom_domain str
    disable_replication_factor_adjustment str
    elasticsearch GetElasticSearchElasticsearchUserConfigElasticsearch
    Elasticsearch server provided values
    elasticsearch_version str
    index_patterns Sequence[GetElasticSearchElasticsearchUserConfigIndexPattern]
    index_template GetElasticSearchElasticsearchUserConfigIndexTemplate
    ip_filters Sequence[str]
    keep_index_refresh_interval str
    kibana GetElasticSearchElasticsearchUserConfigKibana
    max_index_count str
    opensearch_version str
    private_access GetElasticSearchElasticsearchUserConfigPrivateAccess
    privatelink_access GetElasticSearchElasticsearchUserConfigPrivatelinkAccess
    project_to_fork_from str
    public_access GetElasticSearchElasticsearchUserConfigPublicAccess
    recovery_basebackup_name str
    service_to_fork_from str
    static_ips str
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
    customDomain String
    disableReplicationFactorAdjustment String
    elasticsearch Property Map
    Elasticsearch server provided values
    elasticsearchVersion String
    indexPatterns List<Property Map>
    indexTemplate Property Map
    ipFilters List<String>
    keepIndexRefreshInterval String
    kibana Property Map
    maxIndexCount String
    opensearchVersion String
    privateAccess Property Map
    privatelinkAccess Property Map
    projectToForkFrom String
    publicAccess Property Map
    recoveryBasebackupName String
    serviceToForkFrom String
    staticIps String
    Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

    GetElasticSearchElasticsearchUserConfigElasticsearch

    ActionAutoCreateIndexEnabled string
    ActionDestructiveRequiresName string
    ClusterMaxShardsPerNode string
    HttpMaxContentLength string
    HttpMaxHeaderSize string
    HttpMaxInitialLineLength string
    IndicesFielddataCacheSize string
    IndicesMemoryIndexBufferSize string
    IndicesQueriesCacheSize string
    IndicesQueryBoolMaxClauseCount string
    OverrideMainResponseVersion string
    ReindexRemoteWhitelists List<string>
    ScriptMaxCompilationsRate string
    SearchMaxBuckets string
    ThreadPoolAnalyzeQueueSize string
    ThreadPoolAnalyzeSize string
    ThreadPoolForceMergeSize string
    ThreadPoolGetQueueSize string
    ThreadPoolGetSize string
    ThreadPoolIndexSize string
    ThreadPoolSearchQueueSize string
    ThreadPoolSearchSize string
    ThreadPoolSearchThrottledQueueSize string
    ThreadPoolSearchThrottledSize string
    ThreadPoolWriteQueueSize string
    ThreadPoolWriteSize string
    ActionAutoCreateIndexEnabled string
    ActionDestructiveRequiresName string
    ClusterMaxShardsPerNode string
    HttpMaxContentLength string
    HttpMaxHeaderSize string
    HttpMaxInitialLineLength string
    IndicesFielddataCacheSize string
    IndicesMemoryIndexBufferSize string
    IndicesQueriesCacheSize string
    IndicesQueryBoolMaxClauseCount string
    OverrideMainResponseVersion string
    ReindexRemoteWhitelists []string
    ScriptMaxCompilationsRate string
    SearchMaxBuckets string
    ThreadPoolAnalyzeQueueSize string
    ThreadPoolAnalyzeSize string
    ThreadPoolForceMergeSize string
    ThreadPoolGetQueueSize string
    ThreadPoolGetSize string
    ThreadPoolIndexSize string
    ThreadPoolSearchQueueSize string
    ThreadPoolSearchSize string
    ThreadPoolSearchThrottledQueueSize string
    ThreadPoolSearchThrottledSize string
    ThreadPoolWriteQueueSize string
    ThreadPoolWriteSize string
    actionAutoCreateIndexEnabled String
    actionDestructiveRequiresName String
    clusterMaxShardsPerNode String
    httpMaxContentLength String
    httpMaxHeaderSize String
    httpMaxInitialLineLength String
    indicesFielddataCacheSize String
    indicesMemoryIndexBufferSize String
    indicesQueriesCacheSize String
    indicesQueryBoolMaxClauseCount String
    overrideMainResponseVersion String
    reindexRemoteWhitelists List<String>
    scriptMaxCompilationsRate String
    searchMaxBuckets String
    threadPoolAnalyzeQueueSize String
    threadPoolAnalyzeSize String
    threadPoolForceMergeSize String
    threadPoolGetQueueSize String
    threadPoolGetSize String
    threadPoolIndexSize String
    threadPoolSearchQueueSize String
    threadPoolSearchSize String
    threadPoolSearchThrottledQueueSize String
    threadPoolSearchThrottledSize String
    threadPoolWriteQueueSize String
    threadPoolWriteSize String
    actionAutoCreateIndexEnabled string
    actionDestructiveRequiresName string
    clusterMaxShardsPerNode string
    httpMaxContentLength string
    httpMaxHeaderSize string
    httpMaxInitialLineLength string
    indicesFielddataCacheSize string
    indicesMemoryIndexBufferSize string
    indicesQueriesCacheSize string
    indicesQueryBoolMaxClauseCount string
    overrideMainResponseVersion string
    reindexRemoteWhitelists string[]
    scriptMaxCompilationsRate string
    searchMaxBuckets string
    threadPoolAnalyzeQueueSize string
    threadPoolAnalyzeSize string
    threadPoolForceMergeSize string
    threadPoolGetQueueSize string
    threadPoolGetSize string
    threadPoolIndexSize string
    threadPoolSearchQueueSize string
    threadPoolSearchSize string
    threadPoolSearchThrottledQueueSize string
    threadPoolSearchThrottledSize string
    threadPoolWriteQueueSize string
    threadPoolWriteSize string
    action_auto_create_index_enabled str
    action_destructive_requires_name str
    cluster_max_shards_per_node str
    http_max_content_length str
    http_max_header_size str
    http_max_initial_line_length str
    indices_fielddata_cache_size str
    indices_memory_index_buffer_size str
    indices_queries_cache_size str
    indices_query_bool_max_clause_count str
    override_main_response_version str
    reindex_remote_whitelists Sequence[str]
    script_max_compilations_rate str
    search_max_buckets str
    thread_pool_analyze_queue_size str
    thread_pool_analyze_size str
    thread_pool_force_merge_size str
    thread_pool_get_queue_size str
    thread_pool_get_size str
    thread_pool_index_size str
    thread_pool_search_queue_size str
    thread_pool_search_size str
    thread_pool_search_throttled_queue_size str
    thread_pool_search_throttled_size str
    thread_pool_write_queue_size str
    thread_pool_write_size str
    actionAutoCreateIndexEnabled String
    actionDestructiveRequiresName String
    clusterMaxShardsPerNode String
    httpMaxContentLength String
    httpMaxHeaderSize String
    httpMaxInitialLineLength String
    indicesFielddataCacheSize String
    indicesMemoryIndexBufferSize String
    indicesQueriesCacheSize String
    indicesQueryBoolMaxClauseCount String
    overrideMainResponseVersion String
    reindexRemoteWhitelists List<String>
    scriptMaxCompilationsRate String
    searchMaxBuckets String
    threadPoolAnalyzeQueueSize String
    threadPoolAnalyzeSize String
    threadPoolForceMergeSize String
    threadPoolGetQueueSize String
    threadPoolGetSize String
    threadPoolIndexSize String
    threadPoolSearchQueueSize String
    threadPoolSearchSize String
    threadPoolSearchThrottledQueueSize String
    threadPoolSearchThrottledSize String
    threadPoolWriteQueueSize String
    threadPoolWriteSize String

    GetElasticSearchElasticsearchUserConfigIndexPattern

    GetElasticSearchElasticsearchUserConfigIndexTemplate

    GetElasticSearchElasticsearchUserConfigKibana

    GetElasticSearchElasticsearchUserConfigPrivateAccess

    Elasticsearch string
    Elasticsearch server provided values
    Kibana string
    Prometheus string
    Elasticsearch string
    Elasticsearch server provided values
    Kibana string
    Prometheus string
    elasticsearch String
    Elasticsearch server provided values
    kibana String
    prometheus String
    elasticsearch string
    Elasticsearch server provided values
    kibana string
    prometheus string
    elasticsearch str
    Elasticsearch server provided values
    kibana str
    prometheus str
    elasticsearch String
    Elasticsearch server provided values
    kibana String
    prometheus String

    GetElasticSearchElasticsearchUserConfigPrivatelinkAccess

    Elasticsearch string
    Elasticsearch server provided values
    Kibana string
    Prometheus string
    Elasticsearch string
    Elasticsearch server provided values
    Kibana string
    Prometheus string
    elasticsearch String
    Elasticsearch server provided values
    kibana String
    prometheus String
    elasticsearch string
    Elasticsearch server provided values
    kibana string
    prometheus string
    elasticsearch str
    Elasticsearch server provided values
    kibana str
    prometheus str
    elasticsearch String
    Elasticsearch server provided values
    kibana String
    prometheus String

    GetElasticSearchElasticsearchUserConfigPublicAccess

    Elasticsearch string
    Elasticsearch server provided values
    Kibana string
    Prometheus string
    Elasticsearch string
    Elasticsearch server provided values
    Kibana string
    Prometheus string
    elasticsearch String
    Elasticsearch server provided values
    kibana String
    prometheus String
    elasticsearch string
    Elasticsearch server provided values
    kibana string
    prometheus string
    elasticsearch str
    Elasticsearch server provided values
    kibana str
    prometheus str
    elasticsearch String
    Elasticsearch server provided values
    kibana String
    prometheus String

    GetElasticSearchServiceIntegration

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v4.5.2 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.