aiven.getOpenSearch
Explore with Pulumi AI
The OpenSearch data source provides information about the existing Aiven OpenSearch service.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var os1 = Aiven.GetOpenSearch.Invoke(new()
{
Project = data.Aiven_project.Pr1.Project,
ServiceName = "my-os1",
});
});
package main
import (
"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := aiven.LookupOpenSearch(ctx, &aiven.LookupOpenSearchArgs{
Project: data.Aiven_project.Pr1.Project,
ServiceName: "my-os1",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetOpenSearchArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var os1 = AivenFunctions.getOpenSearch(GetOpenSearchArgs.builder()
.project(data.aiven_project().pr1().project())
.serviceName("my-os1")
.build());
}
}
import pulumi
import pulumi_aiven as aiven
os1 = aiven.get_open_search(project=data["aiven_project"]["pr1"]["project"],
service_name="my-os1")
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const os1 = aiven.getOpenSearch({
project: data.aiven_project.pr1.project,
serviceName: "my-os1",
});
variables:
os1:
fn::invoke:
Function: aiven:getOpenSearch
Arguments:
project: ${data.aiven_project.pr1.project}
serviceName: my-os1
Using getOpenSearch
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 getOpenSearch(args: GetOpenSearchArgs, opts?: InvokeOptions): Promise<GetOpenSearchResult>
function getOpenSearchOutput(args: GetOpenSearchOutputArgs, opts?: InvokeOptions): Output<GetOpenSearchResult>
def get_open_search(project: Optional[str] = None,
service_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetOpenSearchResult
def get_open_search_output(project: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetOpenSearchResult]
func LookupOpenSearch(ctx *Context, args *LookupOpenSearchArgs, opts ...InvokeOption) (*LookupOpenSearchResult, error)
func LookupOpenSearchOutput(ctx *Context, args *LookupOpenSearchOutputArgs, opts ...InvokeOption) LookupOpenSearchResultOutput
> Note: This function is named LookupOpenSearch
in the Go SDK.
public static class GetOpenSearch
{
public static Task<GetOpenSearchResult> InvokeAsync(GetOpenSearchArgs args, InvokeOptions? opts = null)
public static Output<GetOpenSearchResult> Invoke(GetOpenSearchInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOpenSearchResult> getOpenSearch(GetOpenSearchArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aiven:index/getOpenSearch:getOpenSearch
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.
- Service
Name 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.
- Service
Name 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.
- service
Name 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.
- service
Name 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.
- service
Name 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.
getOpenSearch Result
The following output properties are available:
- Additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name 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<Get
Open Search Component> Service component information objects
- Disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault 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 stringStep 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 fromdisk_space_default
by increments of this size.- Disk
Space stringUsed Disk space that service is currently using
- Id string
The provider-assigned unique ID for this managed resource.
- Maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Opensearch
User List<GetConfigs Open Search Opensearch User Config> Opensearch user configurable settings
- Opensearches
List<Get
Open Search Opensearch> OpenSearch server provided values
- 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
andpremium-x
wherex
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.
- Project
Vpc stringId 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 string The hostname of the service.
- Service
Integrations List<GetOpen Search Service Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string Password used for connecting to the service, if applicable
- Service
Port int The port of the service
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string Username used for connecting to the service, if applicable
- State string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips 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
- List<Get
Open Search Tag> Tags are key-value pairs that allow you to categorize services.
- 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.
- Additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Cloud
Name 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
[]Get
Open Search Component Service component information objects
- Disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault 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 stringStep 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 fromdisk_space_default
by increments of this size.- Disk
Space stringUsed Disk space that service is currently using
- Id string
The provider-assigned unique ID for this managed resource.
- Maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Opensearch
User []GetConfigs Open Search Opensearch User Config Opensearch user configurable settings
- Opensearches
[]Get
Open Search Opensearch OpenSearch server provided values
- 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
andpremium-x
wherex
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.
- Project
Vpc stringId 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 string The hostname of the service.
- Service
Integrations []GetOpen Search Service Integration Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string Password used for connecting to the service, if applicable
- Service
Port int The port of the service
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string Username used for connecting to the service, if applicable
- State string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips []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
- []Get
Open Search Tag Tags are key-value pairs that allow you to categorize services.
- 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.
- additional
Disk StringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name 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<Get
Open Search Component> Service component information objects
- disk
Space String Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space StringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault 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 StringStep 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 fromdisk_space_default
by increments of this size.- disk
Space StringUsed Disk space that service is currently using
- id String
The provider-assigned unique ID for this managed resource.
- maintenance
Window StringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User List<GetConfigs Open Search Opensearch User Config> Opensearch user configurable settings
- opensearches
List<Get
Open Search Opensearch> OpenSearch server provided values
- 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
andpremium-x
wherex
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.
- project
Vpc StringId 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 String The hostname of the service.
- service
Integrations List<GetOpen Search Service Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String Password used for connecting to the service, if applicable
- service
Port Integer The port of the service
- service
Type String Aiven internal service type code
- service
Uri String URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String Username used for connecting to the service, if applicable
- state String
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Get
Open Search Tag> Tags are key-value pairs that allow you to categorize services.
- termination
Protection 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.
- additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name 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
Get
Open Search Component[] Service component information objects
- disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault 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 stringStep 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 fromdisk_space_default
by increments of this size.- disk
Space stringUsed Disk space that service is currently using
- id string
The provider-assigned unique ID for this managed resource.
- maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User GetConfigs Open Search Opensearch User Config[] Opensearch user configurable settings
- opensearches
Get
Open Search Opensearch[] OpenSearch server provided values
- 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
andpremium-x
wherex
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.
- project
Vpc stringId 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 string The hostname of the service.
- service
Integrations GetOpen Search Service Integration[] Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password string Password used for connecting to the service, if applicable
- service
Port number The port of the service
- service
Type string Aiven internal service type code
- service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string Username used for connecting to the service, if applicable
- state string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- Get
Open Search Tag[] Tags are key-value pairs that allow you to categorize services.
- termination
Protection 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.
- additional_
disk_ strspace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- 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[Get
Open Search Component] Service component information objects
- disk_
space str Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk_
space_ strcap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault 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_ strstep 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 fromdisk_space_default
by increments of this size.- disk_
space_ strused Disk space that service is currently using
- id str
The provider-assigned unique ID for this managed resource.
- maintenance_
window_ strdow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch_
user_ Sequence[Getconfigs Open Search Opensearch User Config] Opensearch user configurable settings
- opensearches
Sequence[Get
Open Search Opensearch] OpenSearch server provided values
- 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
andpremium-x
wherex
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_ strid 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[GetOpen Search Service Integration] 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
orRUNNING
- 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
- Sequence[Get
Open Search Tag] Tags are key-value pairs that allow you to categorize services.
- 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.
- additional
Disk StringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- cloud
Name 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
- disk
Space String Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space StringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault 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 StringStep 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 fromdisk_space_default
by increments of this size.- disk
Space StringUsed Disk space that service is currently using
- id String
The provider-assigned unique ID for this managed resource.
- maintenance
Window StringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- opensearch
User List<Property Map>Configs Opensearch user configurable settings
- opensearches List<Property Map>
OpenSearch server provided values
- 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
andpremium-x
wherex
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.
- project
Vpc StringId 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 String The hostname of the service.
- service
Integrations List<Property Map> Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String Password used for connecting to the service, if applicable
- service
Port Number The port of the service
- service
Type String Aiven internal service type code
- service
Uri String URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String Username used for connecting to the service, if applicable
- state String
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Property Map>
Tags are key-value pairs that allow you to categorize services.
- termination
Protection 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
GetOpenSearchComponent
GetOpenSearchOpensearch
- Opensearch
Dashboards stringUri
- Opensearch
Dashboards stringUri
- opensearch
Dashboards StringUri
- opensearch
Dashboards stringUri
- opensearch
Dashboards StringUri
GetOpenSearchOpensearchUserConfig
- Additional
Backup stringRegions - Custom
Domain string - Disable
Replication boolFactor Adjustment Usage of this field is discouraged.
- Index
Patterns List<GetOpen Search Opensearch User Config Index Pattern> - Index
Template GetOpen Search Opensearch User Config Index Template - Ip
Filter List<GetObjects Open Search Opensearch User Config Ip Filter Object> - Ip
Filter List<string>Strings - Ip
Filters List<string> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- Keep
Index boolRefresh Interval - Max
Index intCount Usage of this field is discouraged.
- Openid
Get
Open Search Opensearch User Config Openid - Opensearch
Get
Open Search Opensearch User Config Opensearch - Opensearch
Dashboards GetOpen Search Opensearch User Config Opensearch Dashboards - Opensearch
Version string - Private
Access GetOpen Search Opensearch User Config Private Access - Privatelink
Access GetOpen Search Opensearch User Config Privatelink Access - Project
To stringFork From - Public
Access GetOpen Search Opensearch User Config Public Access - Recovery
Basebackup stringName - Saml
Get
Open Search Opensearch User Config Saml - Service
To stringFork From - Static
Ips bool
- Additional
Backup stringRegions - Custom
Domain string - Disable
Replication boolFactor Adjustment Usage of this field is discouraged.
- Index
Patterns []GetOpen Search Opensearch User Config Index Pattern - Index
Template GetOpen Search Opensearch User Config Index Template - Ip
Filter []GetObjects Open Search Opensearch User Config Ip Filter Object - Ip
Filter []stringStrings - Ip
Filters []string This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- Keep
Index boolRefresh Interval - Max
Index intCount Usage of this field is discouraged.
- Openid
Get
Open Search Opensearch User Config Openid - Opensearch
Get
Open Search Opensearch User Config Opensearch - Opensearch
Dashboards GetOpen Search Opensearch User Config Opensearch Dashboards - Opensearch
Version string - Private
Access GetOpen Search Opensearch User Config Private Access - Privatelink
Access GetOpen Search Opensearch User Config Privatelink Access - Project
To stringFork From - Public
Access GetOpen Search Opensearch User Config Public Access - Recovery
Basebackup stringName - Saml
Get
Open Search Opensearch User Config Saml - Service
To stringFork From - Static
Ips bool
- additional
Backup StringRegions - custom
Domain String - disable
Replication BooleanFactor Adjustment Usage of this field is discouraged.
- index
Patterns List<GetOpen Search Opensearch User Config Index Pattern> - index
Template GetOpen Search Opensearch User Config Index Template - ip
Filter List<GetObjects Open Search Opensearch User Config Ip Filter Object> - ip
Filter List<String>Strings - ip
Filters List<String> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- keep
Index BooleanRefresh Interval - max
Index IntegerCount Usage of this field is discouraged.
- openid
Get
Open Search Opensearch User Config Openid - opensearch
Get
Open Search Opensearch User Config Opensearch - opensearch
Dashboards GetOpen Search Opensearch User Config Opensearch Dashboards - opensearch
Version String - private
Access GetOpen Search Opensearch User Config Private Access - privatelink
Access GetOpen Search Opensearch User Config Privatelink Access - project
To StringFork From - public
Access GetOpen Search Opensearch User Config Public Access - recovery
Basebackup StringName - saml
Get
Open Search Opensearch User Config Saml - service
To StringFork From - static
Ips Boolean
- additional
Backup stringRegions - custom
Domain string - disable
Replication booleanFactor Adjustment Usage of this field is discouraged.
- index
Patterns GetOpen Search Opensearch User Config Index Pattern[] - index
Template GetOpen Search Opensearch User Config Index Template - ip
Filter GetObjects Open Search Opensearch User Config Ip Filter Object[] - ip
Filter string[]Strings - ip
Filters string[] This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- keep
Index booleanRefresh Interval - max
Index numberCount Usage of this field is discouraged.
- openid
Get
Open Search Opensearch User Config Openid - opensearch
Get
Open Search Opensearch User Config Opensearch - opensearch
Dashboards GetOpen Search Opensearch User Config Opensearch Dashboards - opensearch
Version string - private
Access GetOpen Search Opensearch User Config Private Access - privatelink
Access GetOpen Search Opensearch User Config Privatelink Access - project
To stringFork From - public
Access GetOpen Search Opensearch User Config Public Access - recovery
Basebackup stringName - saml
Get
Open Search Opensearch User Config Saml - service
To stringFork From - static
Ips boolean
- additional_
backup_ strregions - custom_
domain str - disable_
replication_ boolfactor_ adjustment Usage of this field is discouraged.
- index_
patterns Sequence[GetOpen Search Opensearch User Config Index Pattern] - index_
template GetOpen Search Opensearch User Config Index Template - ip_
filter_ Sequence[Getobjects Open Search Opensearch User Config Ip Filter Object] - ip_
filter_ Sequence[str]strings - ip_
filters Sequence[str] This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- keep_
index_ boolrefresh_ interval - max_
index_ intcount Usage of this field is discouraged.
- openid
Get
Open Search Opensearch User Config Openid - opensearch
Get
Open Search Opensearch User Config Opensearch - opensearch_
dashboards GetOpen Search Opensearch User Config Opensearch Dashboards - opensearch_
version str - private_
access GetOpen Search Opensearch User Config Private Access - privatelink_
access GetOpen Search Opensearch User Config Privatelink Access - project_
to_ strfork_ from - public_
access GetOpen Search Opensearch User Config Public Access - recovery_
basebackup_ strname - saml
Get
Open Search Opensearch User Config Saml - service_
to_ strfork_ from - static_
ips bool
- additional
Backup StringRegions - custom
Domain String - disable
Replication BooleanFactor Adjustment Usage of this field is discouraged.
- index
Patterns List<Property Map> - index
Template Property Map - ip
Filter List<Property Map>Objects - ip
Filter List<String>Strings - ip
Filters List<String> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- keep
Index BooleanRefresh Interval - max
Index NumberCount Usage of this field is discouraged.
- openid Property Map
- opensearch Property Map
- opensearch
Dashboards Property Map - opensearch
Version String - private
Access Property Map - privatelink
Access Property Map - project
To StringFork From - public
Access Property Map - recovery
Basebackup StringName - saml Property Map
- service
To StringFork From - static
Ips Boolean
GetOpenSearchOpensearchUserConfigIndexPattern
- Max
Index intCount - Pattern string
- Sorting
Algorithm string
- Max
Index intCount - Pattern string
- Sorting
Algorithm string
- max
Index IntegerCount - pattern String
- sorting
Algorithm String
- max
Index numberCount - pattern string
- sorting
Algorithm string
- max_
index_ intcount - pattern str
- sorting_
algorithm str
- max
Index NumberCount - pattern String
- sorting
Algorithm String
GetOpenSearchOpensearchUserConfigIndexTemplate
- mapping
Nested IntegerObjects Limit - number
Of IntegerReplicas - number
Of IntegerShards
- mapping
Nested numberObjects Limit - number
Of numberReplicas - number
Of numberShards
- mapping
Nested NumberObjects Limit - number
Of NumberReplicas - number
Of NumberShards
GetOpenSearchOpensearchUserConfigIpFilterObject
- Network string
- Description string
- Network string
- Description string
- network String
- description String
- network string
- description string
- network str
- description str
- network String
- description String
GetOpenSearchOpensearchUserConfigOpenid
- Client
Id string - Client
Secret string - Connect
Url string - Enabled bool
- Header string
- Jwt
Header string - Jwt
Url stringParameter - Refresh
Rate intLimit Count - Refresh
Rate intLimit Time Window Ms - Roles
Key string - Scope string
- Subject
Key string
- Client
Id string - Client
Secret string - Connect
Url string - Enabled bool
- Header string
- Jwt
Header string - Jwt
Url stringParameter - Refresh
Rate intLimit Count - Refresh
Rate intLimit Time Window Ms - Roles
Key string - Scope string
- Subject
Key string
- client
Id String - client
Secret String - connect
Url String - enabled Boolean
- header String
- jwt
Header String - jwt
Url StringParameter - refresh
Rate IntegerLimit Count - refresh
Rate IntegerLimit Time Window Ms - roles
Key String - scope String
- subject
Key String
- client
Id string - client
Secret string - connect
Url string - enabled boolean
- header string
- jwt
Header string - jwt
Url stringParameter - refresh
Rate numberLimit Count - refresh
Rate numberLimit Time Window Ms - roles
Key string - scope string
- subject
Key string
- client_
id str - client_
secret str - connect_
url str - enabled bool
- header str
- jwt_
header str - jwt_
url_ strparameter - refresh_
rate_ intlimit_ count - refresh_
rate_ intlimit_ time_ window_ ms - roles_
key str - scope str
- subject_
key str
- client
Id String - client
Secret String - connect
Url String - enabled Boolean
- header String
- jwt
Header String - jwt
Url StringParameter - refresh
Rate NumberLimit Count - refresh
Rate NumberLimit Time Window Ms - roles
Key String - scope String
- subject
Key String
GetOpenSearchOpensearchUserConfigOpensearch
- Action
Auto boolCreate Index Enabled - Action
Destructive boolRequires Name - Cluster
Max intShards Per Node - Cluster
Routing intAllocation Node Concurrent Recoveries - Email
Sender stringName - Email
Sender stringPassword - Email
Sender stringUsername - Http
Max intContent Length - Http
Max intHeader Size - Http
Max intInitial Line Length - Indices
Fielddata intCache Size - Indices
Memory intIndex Buffer Size - Indices
Queries intCache Size - Indices
Query intBool Max Clause Count - Indices
Recovery intMax Bytes Per Sec - Indices
Recovery intMax Concurrent File Chunks - Override
Main boolResponse Version - Reindex
Remote List<string>Whitelists - Script
Max stringCompilations Rate - Search
Max intBuckets - Thread
Pool intAnalyze Queue Size - Thread
Pool intAnalyze Size - Thread
Pool intForce Merge Size - Thread
Pool intGet Queue Size - Thread
Pool intGet Size - Thread
Pool intSearch Queue Size - Thread
Pool intSearch Size - Thread
Pool intSearch Throttled Queue Size - Thread
Pool intSearch Throttled Size - Thread
Pool intWrite Queue Size - Thread
Pool intWrite Size
- Action
Auto boolCreate Index Enabled - Action
Destructive boolRequires Name - Cluster
Max intShards Per Node - Cluster
Routing intAllocation Node Concurrent Recoveries - Email
Sender stringName - Email
Sender stringPassword - Email
Sender stringUsername - Http
Max intContent Length - Http
Max intHeader Size - Http
Max intInitial Line Length - Indices
Fielddata intCache Size - Indices
Memory intIndex Buffer Size - Indices
Queries intCache Size - Indices
Query intBool Max Clause Count - Indices
Recovery intMax Bytes Per Sec - Indices
Recovery intMax Concurrent File Chunks - Override
Main boolResponse Version - Reindex
Remote []stringWhitelists - Script
Max stringCompilations Rate - Search
Max intBuckets - Thread
Pool intAnalyze Queue Size - Thread
Pool intAnalyze Size - Thread
Pool intForce Merge Size - Thread
Pool intGet Queue Size - Thread
Pool intGet Size - Thread
Pool intSearch Queue Size - Thread
Pool intSearch Size - Thread
Pool intSearch Throttled Queue Size - Thread
Pool intSearch Throttled Size - Thread
Pool intWrite Queue Size - Thread
Pool intWrite Size
- action
Auto BooleanCreate Index Enabled - action
Destructive BooleanRequires Name - cluster
Max IntegerShards Per Node - cluster
Routing IntegerAllocation Node Concurrent Recoveries - email
Sender StringName - email
Sender StringPassword - email
Sender StringUsername - http
Max IntegerContent Length - http
Max IntegerHeader Size - http
Max IntegerInitial Line Length - indices
Fielddata IntegerCache Size - indices
Memory IntegerIndex Buffer Size - indices
Queries IntegerCache Size - indices
Query IntegerBool Max Clause Count - indices
Recovery IntegerMax Bytes Per Sec - indices
Recovery IntegerMax Concurrent File Chunks - override
Main BooleanResponse Version - reindex
Remote List<String>Whitelists - script
Max StringCompilations Rate - search
Max IntegerBuckets - thread
Pool IntegerAnalyze Queue Size - thread
Pool IntegerAnalyze Size - thread
Pool IntegerForce Merge Size - thread
Pool IntegerGet Queue Size - thread
Pool IntegerGet Size - thread
Pool IntegerSearch Queue Size - thread
Pool IntegerSearch Size - thread
Pool IntegerSearch Throttled Queue Size - thread
Pool IntegerSearch Throttled Size - thread
Pool IntegerWrite Queue Size - thread
Pool IntegerWrite Size
- action
Auto booleanCreate Index Enabled - action
Destructive booleanRequires Name - cluster
Max numberShards Per Node - cluster
Routing numberAllocation Node Concurrent Recoveries - email
Sender stringName - email
Sender stringPassword - email
Sender stringUsername - http
Max numberContent Length - http
Max numberHeader Size - http
Max numberInitial Line Length - indices
Fielddata numberCache Size - indices
Memory numberIndex Buffer Size - indices
Queries numberCache Size - indices
Query numberBool Max Clause Count - indices
Recovery numberMax Bytes Per Sec - indices
Recovery numberMax Concurrent File Chunks - override
Main booleanResponse Version - reindex
Remote string[]Whitelists - script
Max stringCompilations Rate - search
Max numberBuckets - thread
Pool numberAnalyze Queue Size - thread
Pool numberAnalyze Size - thread
Pool numberForce Merge Size - thread
Pool numberGet Queue Size - thread
Pool numberGet Size - thread
Pool numberSearch Queue Size - thread
Pool numberSearch Size - thread
Pool numberSearch Throttled Queue Size - thread
Pool numberSearch Throttled Size - thread
Pool numberWrite Queue Size - thread
Pool numberWrite Size
- action_
auto_ boolcreate_ index_ enabled - action_
destructive_ boolrequires_ name - cluster_
max_ intshards_ per_ node - cluster_
routing_ intallocation_ node_ concurrent_ recoveries - email_
sender_ strname - email_
sender_ strpassword - email_
sender_ strusername - http_
max_ intcontent_ length - http_
max_ intheader_ size - http_
max_ intinitial_ line_ length - indices_
fielddata_ intcache_ size - indices_
memory_ intindex_ buffer_ size - indices_
queries_ intcache_ size - indices_
query_ intbool_ max_ clause_ count - indices_
recovery_ intmax_ bytes_ per_ sec - indices_
recovery_ intmax_ concurrent_ file_ chunks - override_
main_ boolresponse_ version - reindex_
remote_ Sequence[str]whitelists - script_
max_ strcompilations_ rate - search_
max_ intbuckets - thread_
pool_ intanalyze_ queue_ size - thread_
pool_ intanalyze_ size - thread_
pool_ intforce_ merge_ size - thread_
pool_ intget_ queue_ size - thread_
pool_ intget_ size - thread_
pool_ intsearch_ queue_ size - thread_
pool_ intsearch_ size - thread_
pool_ intsearch_ throttled_ queue_ size - thread_
pool_ intsearch_ throttled_ size - thread_
pool_ intwrite_ queue_ size - thread_
pool_ intwrite_ size
- action
Auto BooleanCreate Index Enabled - action
Destructive BooleanRequires Name - cluster
Max NumberShards Per Node - cluster
Routing NumberAllocation Node Concurrent Recoveries - email
Sender StringName - email
Sender StringPassword - email
Sender StringUsername - http
Max NumberContent Length - http
Max NumberHeader Size - http
Max NumberInitial Line Length - indices
Fielddata NumberCache Size - indices
Memory NumberIndex Buffer Size - indices
Queries NumberCache Size - indices
Query NumberBool Max Clause Count - indices
Recovery NumberMax Bytes Per Sec - indices
Recovery NumberMax Concurrent File Chunks - override
Main BooleanResponse Version - reindex
Remote List<String>Whitelists - script
Max StringCompilations Rate - search
Max NumberBuckets - thread
Pool NumberAnalyze Queue Size - thread
Pool NumberAnalyze Size - thread
Pool NumberForce Merge Size - thread
Pool NumberGet Queue Size - thread
Pool NumberGet Size - thread
Pool NumberSearch Queue Size - thread
Pool NumberSearch Size - thread
Pool NumberSearch Throttled Queue Size - thread
Pool NumberSearch Throttled Size - thread
Pool NumberWrite Queue Size - thread
Pool NumberWrite Size
GetOpenSearchOpensearchUserConfigOpensearchDashboards
- Enabled bool
- Max
Old intSpace Size - Opensearch
Request intTimeout
- Enabled bool
- Max
Old intSpace Size - Opensearch
Request intTimeout
- enabled Boolean
- max
Old IntegerSpace Size - opensearch
Request IntegerTimeout
- enabled boolean
- max
Old numberSpace Size - opensearch
Request numberTimeout
- enabled bool
- max_
old_ intspace_ size - opensearch_
request_ inttimeout
- enabled Boolean
- max
Old NumberSpace Size - opensearch
Request NumberTimeout
GetOpenSearchOpensearchUserConfigPrivateAccess
- Opensearch bool
- Opensearch
Dashboards bool - Prometheus bool
- Opensearch bool
- Opensearch
Dashboards bool - Prometheus bool
- opensearch Boolean
- opensearch
Dashboards Boolean - prometheus Boolean
- opensearch boolean
- opensearch
Dashboards boolean - prometheus boolean
- opensearch bool
- opensearch_
dashboards bool - prometheus bool
- opensearch Boolean
- opensearch
Dashboards Boolean - prometheus Boolean
GetOpenSearchOpensearchUserConfigPrivatelinkAccess
- Opensearch bool
- Opensearch
Dashboards bool - Prometheus bool
- Opensearch bool
- Opensearch
Dashboards bool - Prometheus bool
- opensearch Boolean
- opensearch
Dashboards Boolean - prometheus Boolean
- opensearch boolean
- opensearch
Dashboards boolean - prometheus boolean
- opensearch bool
- opensearch_
dashboards bool - prometheus bool
- opensearch Boolean
- opensearch
Dashboards Boolean - prometheus Boolean
GetOpenSearchOpensearchUserConfigPublicAccess
- Opensearch bool
- Opensearch
Dashboards bool - Prometheus bool
- Opensearch bool
- Opensearch
Dashboards bool - Prometheus bool
- opensearch Boolean
- opensearch
Dashboards Boolean - prometheus Boolean
- opensearch boolean
- opensearch
Dashboards boolean - prometheus boolean
- opensearch bool
- opensearch_
dashboards bool - prometheus bool
- opensearch Boolean
- opensearch
Dashboards Boolean - prometheus Boolean
GetOpenSearchOpensearchUserConfigSaml
- Enabled bool
- Idp
Entity stringId - Idp
Metadata stringUrl - Sp
Entity stringId - Idp
Pemtrustedcas stringContent - Roles
Key string - Subject
Key string
- Enabled bool
- Idp
Entity stringId - Idp
Metadata stringUrl - Sp
Entity stringId - Idp
Pemtrustedcas stringContent - Roles
Key string - Subject
Key string
- enabled Boolean
- idp
Entity StringId - idp
Metadata StringUrl - sp
Entity StringId - idp
Pemtrustedcas StringContent - roles
Key String - subject
Key String
- enabled boolean
- idp
Entity stringId - idp
Metadata stringUrl - sp
Entity stringId - idp
Pemtrustedcas stringContent - roles
Key string - subject
Key string
- enabled bool
- idp_
entity_ strid - idp_
metadata_ strurl - sp_
entity_ strid - idp_
pemtrustedcas_ strcontent - roles_
key str - subject_
key str
- enabled Boolean
- idp
Entity StringId - idp
Metadata StringUrl - sp
Entity StringId - idp
Pemtrustedcas StringContent - roles
Key String - subject
Key String
GetOpenSearchServiceIntegration
- Integration
Type string - Source
Service stringName
- Integration
Type string - Source
Service stringName
- integration
Type String - source
Service StringName
- integration
Type string - source
Service stringName
- integration
Type String - source
Service StringName
GetOpenSearchTag
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aiven
Terraform Provider.