1. Packages
  2. Aiven
  3. API Docs
  4. getOpenSearch
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

aiven.getOpenSearch

Explore with Pulumi AI

aiven logo
Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

    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.

    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.

    getOpenSearch Result

    The following output properties are available:

    AdditionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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<GetOpenSearchComponent>

    Service component information objects

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

    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

    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.

    OpensearchUserConfigs List<GetOpenSearchOpensearchUserConfig>

    Opensearch user configurable settings

    Opensearches List<GetOpenSearchOpensearch>

    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 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<GetOpenSearchServiceIntegration>

    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

    Tags List<GetOpenSearchTag>

    Tags are key-value pairs that allow you to categorize services.

    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.

    AdditionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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 []GetOpenSearchComponent

    Service component information objects

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

    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

    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.

    OpensearchUserConfigs []GetOpenSearchOpensearchUserConfig

    Opensearch user configurable settings

    Opensearches []GetOpenSearchOpensearch

    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 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 []GetOpenSearchServiceIntegration

    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

    Tags []GetOpenSearchTag

    Tags are key-value pairs that allow you to categorize services.

    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.

    additionalDiskSpace String

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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<GetOpenSearchComponent>

    Service component information objects

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

    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

    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.

    opensearchUserConfigs List<GetOpenSearchOpensearchUserConfig>

    Opensearch user configurable settings

    opensearches List<GetOpenSearchOpensearch>

    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 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<GetOpenSearchServiceIntegration>

    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

    tags List<GetOpenSearchTag>

    Tags are key-value pairs that allow you to categorize services.

    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.

    additionalDiskSpace string

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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 GetOpenSearchComponent[]

    Service component information objects

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

    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

    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.

    opensearchUserConfigs GetOpenSearchOpensearchUserConfig[]

    Opensearch user configurable settings

    opensearches GetOpenSearchOpensearch[]

    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 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 GetOpenSearchServiceIntegration[]

    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

    tags GetOpenSearchTag[]

    Tags are key-value pairs that allow you to categorize services.

    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.

    additional_disk_space str

    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[GetOpenSearchComponent]

    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_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

    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.

    opensearch_user_configs Sequence[GetOpenSearchOpensearchUserConfig]

    Opensearch user configurable settings

    opensearches Sequence[GetOpenSearchOpensearch]

    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 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[GetOpenSearchServiceIntegration]

    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

    tags Sequence[GetOpenSearchTag]

    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.

    additionalDiskSpace String

    Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

    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

    Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, 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

    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.

    opensearchUserConfigs List<Property Map>

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

    tags List<Property Map>

    Tags are key-value pairs that allow you to categorize services.

    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

    GetOpenSearchComponent

    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

    GetOpenSearchOpensearch

    GetOpenSearchOpensearchUserConfig

    AdditionalBackupRegions string
    CustomDomain string
    DisableReplicationFactorAdjustment bool

    Deprecated:

    Usage of this field is discouraged.

    IndexPatterns List<GetOpenSearchOpensearchUserConfigIndexPattern>
    IndexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate
    IpFilterObjects List<GetOpenSearchOpensearchUserConfigIpFilterObject>
    IpFilterStrings List<string>
    IpFilters List<string>

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    KeepIndexRefreshInterval bool
    MaxIndexCount int

    Deprecated:

    Usage of this field is discouraged.

    Openid GetOpenSearchOpensearchUserConfigOpenid
    Opensearch GetOpenSearchOpensearchUserConfigOpensearch
    OpensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards
    OpensearchVersion string
    PrivateAccess GetOpenSearchOpensearchUserConfigPrivateAccess
    PrivatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess
    ProjectToForkFrom string
    PublicAccess GetOpenSearchOpensearchUserConfigPublicAccess
    RecoveryBasebackupName string
    Saml GetOpenSearchOpensearchUserConfigSaml
    ServiceToForkFrom string
    StaticIps bool
    AdditionalBackupRegions string
    CustomDomain string
    DisableReplicationFactorAdjustment bool

    Deprecated:

    Usage of this field is discouraged.

    IndexPatterns []GetOpenSearchOpensearchUserConfigIndexPattern
    IndexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate
    IpFilterObjects []GetOpenSearchOpensearchUserConfigIpFilterObject
    IpFilterStrings []string
    IpFilters []string

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    KeepIndexRefreshInterval bool
    MaxIndexCount int

    Deprecated:

    Usage of this field is discouraged.

    Openid GetOpenSearchOpensearchUserConfigOpenid
    Opensearch GetOpenSearchOpensearchUserConfigOpensearch
    OpensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards
    OpensearchVersion string
    PrivateAccess GetOpenSearchOpensearchUserConfigPrivateAccess
    PrivatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess
    ProjectToForkFrom string
    PublicAccess GetOpenSearchOpensearchUserConfigPublicAccess
    RecoveryBasebackupName string
    Saml GetOpenSearchOpensearchUserConfigSaml
    ServiceToForkFrom string
    StaticIps bool
    additionalBackupRegions String
    customDomain String
    disableReplicationFactorAdjustment Boolean

    Deprecated:

    Usage of this field is discouraged.

    indexPatterns List<GetOpenSearchOpensearchUserConfigIndexPattern>
    indexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate
    ipFilterObjects List<GetOpenSearchOpensearchUserConfigIpFilterObject>
    ipFilterStrings List<String>
    ipFilters List<String>

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    keepIndexRefreshInterval Boolean
    maxIndexCount Integer

    Deprecated:

    Usage of this field is discouraged.

    openid GetOpenSearchOpensearchUserConfigOpenid
    opensearch GetOpenSearchOpensearchUserConfigOpensearch
    opensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards
    opensearchVersion String
    privateAccess GetOpenSearchOpensearchUserConfigPrivateAccess
    privatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess
    projectToForkFrom String
    publicAccess GetOpenSearchOpensearchUserConfigPublicAccess
    recoveryBasebackupName String
    saml GetOpenSearchOpensearchUserConfigSaml
    serviceToForkFrom String
    staticIps Boolean
    additionalBackupRegions string
    customDomain string
    disableReplicationFactorAdjustment boolean

    Deprecated:

    Usage of this field is discouraged.

    indexPatterns GetOpenSearchOpensearchUserConfigIndexPattern[]
    indexTemplate GetOpenSearchOpensearchUserConfigIndexTemplate
    ipFilterObjects GetOpenSearchOpensearchUserConfigIpFilterObject[]
    ipFilterStrings string[]
    ipFilters string[]

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    keepIndexRefreshInterval boolean
    maxIndexCount number

    Deprecated:

    Usage of this field is discouraged.

    openid GetOpenSearchOpensearchUserConfigOpenid
    opensearch GetOpenSearchOpensearchUserConfigOpensearch
    opensearchDashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards
    opensearchVersion string
    privateAccess GetOpenSearchOpensearchUserConfigPrivateAccess
    privatelinkAccess GetOpenSearchOpensearchUserConfigPrivatelinkAccess
    projectToForkFrom string
    publicAccess GetOpenSearchOpensearchUserConfigPublicAccess
    recoveryBasebackupName string
    saml GetOpenSearchOpensearchUserConfigSaml
    serviceToForkFrom string
    staticIps boolean
    additional_backup_regions str
    custom_domain str
    disable_replication_factor_adjustment bool

    Deprecated:

    Usage of this field is discouraged.

    index_patterns Sequence[GetOpenSearchOpensearchUserConfigIndexPattern]
    index_template GetOpenSearchOpensearchUserConfigIndexTemplate
    ip_filter_objects Sequence[GetOpenSearchOpensearchUserConfigIpFilterObject]
    ip_filter_strings Sequence[str]
    ip_filters Sequence[str]

    Deprecated:

    This will be removed in v5.0.0 and replaced with ip_filter_string instead.

    keep_index_refresh_interval bool
    max_index_count int

    Deprecated:

    Usage of this field is discouraged.

    openid GetOpenSearchOpensearchUserConfigOpenid
    opensearch GetOpenSearchOpensearchUserConfigOpensearch
    opensearch_dashboards GetOpenSearchOpensearchUserConfigOpensearchDashboards
    opensearch_version str
    private_access GetOpenSearchOpensearchUserConfigPrivateAccess
    privatelink_access GetOpenSearchOpensearchUserConfigPrivatelinkAccess
    project_to_fork_from str
    public_access GetOpenSearchOpensearchUserConfigPublicAccess
    recovery_basebackup_name str
    saml GetOpenSearchOpensearchUserConfigSaml
    service_to_fork_from str
    static_ips bool

    GetOpenSearchOpensearchUserConfigIndexPattern

    GetOpenSearchOpensearchUserConfigIndexTemplate

    GetOpenSearchOpensearchUserConfigIpFilterObject

    Network string
    Description string
    Network string
    Description string
    network String
    description String
    network string
    description string
    network String
    description String

    GetOpenSearchOpensearchUserConfigOpenid

    GetOpenSearchOpensearchUserConfigOpensearch

    ActionAutoCreateIndexEnabled bool
    ActionDestructiveRequiresName bool
    ClusterMaxShardsPerNode int
    ClusterRoutingAllocationNodeConcurrentRecoveries int
    EmailSenderName string
    EmailSenderPassword string
    EmailSenderUsername string
    HttpMaxContentLength int
    HttpMaxHeaderSize int
    HttpMaxInitialLineLength int
    IndicesFielddataCacheSize int
    IndicesMemoryIndexBufferSize int
    IndicesQueriesCacheSize int
    IndicesQueryBoolMaxClauseCount int
    IndicesRecoveryMaxBytesPerSec int
    IndicesRecoveryMaxConcurrentFileChunks int
    OverrideMainResponseVersion bool
    ReindexRemoteWhitelists List<string>
    ScriptMaxCompilationsRate string
    SearchMaxBuckets int
    ThreadPoolAnalyzeQueueSize int
    ThreadPoolAnalyzeSize int
    ThreadPoolForceMergeSize int
    ThreadPoolGetQueueSize int
    ThreadPoolGetSize int
    ThreadPoolSearchQueueSize int
    ThreadPoolSearchSize int
    ThreadPoolSearchThrottledQueueSize int
    ThreadPoolSearchThrottledSize int
    ThreadPoolWriteQueueSize int
    ThreadPoolWriteSize int
    ActionAutoCreateIndexEnabled bool
    ActionDestructiveRequiresName bool
    ClusterMaxShardsPerNode int
    ClusterRoutingAllocationNodeConcurrentRecoveries int
    EmailSenderName string
    EmailSenderPassword string
    EmailSenderUsername string
    HttpMaxContentLength int
    HttpMaxHeaderSize int
    HttpMaxInitialLineLength int
    IndicesFielddataCacheSize int
    IndicesMemoryIndexBufferSize int
    IndicesQueriesCacheSize int
    IndicesQueryBoolMaxClauseCount int
    IndicesRecoveryMaxBytesPerSec int
    IndicesRecoveryMaxConcurrentFileChunks int
    OverrideMainResponseVersion bool
    ReindexRemoteWhitelists []string
    ScriptMaxCompilationsRate string
    SearchMaxBuckets int
    ThreadPoolAnalyzeQueueSize int
    ThreadPoolAnalyzeSize int
    ThreadPoolForceMergeSize int
    ThreadPoolGetQueueSize int
    ThreadPoolGetSize int
    ThreadPoolSearchQueueSize int
    ThreadPoolSearchSize int
    ThreadPoolSearchThrottledQueueSize int
    ThreadPoolSearchThrottledSize int
    ThreadPoolWriteQueueSize int
    ThreadPoolWriteSize int
    actionAutoCreateIndexEnabled Boolean
    actionDestructiveRequiresName Boolean
    clusterMaxShardsPerNode Integer
    clusterRoutingAllocationNodeConcurrentRecoveries Integer
    emailSenderName String
    emailSenderPassword String
    emailSenderUsername String
    httpMaxContentLength Integer
    httpMaxHeaderSize Integer
    httpMaxInitialLineLength Integer
    indicesFielddataCacheSize Integer
    indicesMemoryIndexBufferSize Integer
    indicesQueriesCacheSize Integer
    indicesQueryBoolMaxClauseCount Integer
    indicesRecoveryMaxBytesPerSec Integer
    indicesRecoveryMaxConcurrentFileChunks Integer
    overrideMainResponseVersion Boolean
    reindexRemoteWhitelists List<String>
    scriptMaxCompilationsRate String
    searchMaxBuckets Integer
    threadPoolAnalyzeQueueSize Integer
    threadPoolAnalyzeSize Integer
    threadPoolForceMergeSize Integer
    threadPoolGetQueueSize Integer
    threadPoolGetSize Integer
    threadPoolSearchQueueSize Integer
    threadPoolSearchSize Integer
    threadPoolSearchThrottledQueueSize Integer
    threadPoolSearchThrottledSize Integer
    threadPoolWriteQueueSize Integer
    threadPoolWriteSize Integer
    actionAutoCreateIndexEnabled boolean
    actionDestructiveRequiresName boolean
    clusterMaxShardsPerNode number
    clusterRoutingAllocationNodeConcurrentRecoveries number
    emailSenderName string
    emailSenderPassword string
    emailSenderUsername string
    httpMaxContentLength number
    httpMaxHeaderSize number
    httpMaxInitialLineLength number
    indicesFielddataCacheSize number
    indicesMemoryIndexBufferSize number
    indicesQueriesCacheSize number
    indicesQueryBoolMaxClauseCount number
    indicesRecoveryMaxBytesPerSec number
    indicesRecoveryMaxConcurrentFileChunks number
    overrideMainResponseVersion boolean
    reindexRemoteWhitelists string[]
    scriptMaxCompilationsRate string
    searchMaxBuckets number
    threadPoolAnalyzeQueueSize number
    threadPoolAnalyzeSize number
    threadPoolForceMergeSize number
    threadPoolGetQueueSize number
    threadPoolGetSize number
    threadPoolSearchQueueSize number
    threadPoolSearchSize number
    threadPoolSearchThrottledQueueSize number
    threadPoolSearchThrottledSize number
    threadPoolWriteQueueSize number
    threadPoolWriteSize number
    action_auto_create_index_enabled bool
    action_destructive_requires_name bool
    cluster_max_shards_per_node int
    cluster_routing_allocation_node_concurrent_recoveries int
    email_sender_name str
    email_sender_password str
    email_sender_username str
    http_max_content_length int
    http_max_header_size int
    http_max_initial_line_length int
    indices_fielddata_cache_size int
    indices_memory_index_buffer_size int
    indices_queries_cache_size int
    indices_query_bool_max_clause_count int
    indices_recovery_max_bytes_per_sec int
    indices_recovery_max_concurrent_file_chunks int
    override_main_response_version bool
    reindex_remote_whitelists Sequence[str]
    script_max_compilations_rate str
    search_max_buckets int
    thread_pool_analyze_queue_size int
    thread_pool_analyze_size int
    thread_pool_force_merge_size int
    thread_pool_get_queue_size int
    thread_pool_get_size int
    thread_pool_search_queue_size int
    thread_pool_search_size int
    thread_pool_search_throttled_queue_size int
    thread_pool_search_throttled_size int
    thread_pool_write_queue_size int
    thread_pool_write_size int
    actionAutoCreateIndexEnabled Boolean
    actionDestructiveRequiresName Boolean
    clusterMaxShardsPerNode Number
    clusterRoutingAllocationNodeConcurrentRecoveries Number
    emailSenderName String
    emailSenderPassword String
    emailSenderUsername String
    httpMaxContentLength Number
    httpMaxHeaderSize Number
    httpMaxInitialLineLength Number
    indicesFielddataCacheSize Number
    indicesMemoryIndexBufferSize Number
    indicesQueriesCacheSize Number
    indicesQueryBoolMaxClauseCount Number
    indicesRecoveryMaxBytesPerSec Number
    indicesRecoveryMaxConcurrentFileChunks Number
    overrideMainResponseVersion Boolean
    reindexRemoteWhitelists List<String>
    scriptMaxCompilationsRate String
    searchMaxBuckets Number
    threadPoolAnalyzeQueueSize Number
    threadPoolAnalyzeSize Number
    threadPoolForceMergeSize Number
    threadPoolGetQueueSize Number
    threadPoolGetSize Number
    threadPoolSearchQueueSize Number
    threadPoolSearchSize Number
    threadPoolSearchThrottledQueueSize Number
    threadPoolSearchThrottledSize Number
    threadPoolWriteQueueSize Number
    threadPoolWriteSize Number

    GetOpenSearchOpensearchUserConfigOpensearchDashboards

    GetOpenSearchOpensearchUserConfigPrivateAccess

    GetOpenSearchOpensearchUserConfigPrivatelinkAccess

    GetOpenSearchOpensearchUserConfigPublicAccess

    GetOpenSearchOpensearchUserConfigSaml

    GetOpenSearchServiceIntegration

    GetOpenSearchTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aiven Terraform Provider.

    aiven logo
    Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi