Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. Clickhouse
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

aiven.Clickhouse

Explore with Pulumi AI

aiven logo
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-aiven

    Creates and manages an Aiven for ClickHouse® service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const exampleClickhouse = new aiven.Clickhouse("example_clickhouse", {
    project: exampleProject.project,
    cloudName: "google-europe-west1",
    plan: "business-4",
    serviceName: "example-clickhouse-service",
    maintenanceWindowDow: "monday",
    maintenanceWindowTime: "10:00:00",
});

    import pulumi
import pulumi_aiven as aiven

example_clickhouse = aiven.Clickhouse("example_clickhouse",
    project=example_project["project"],
    cloud_name="google-europe-west1",
    plan="business-4",
    service_name="example-clickhouse-service",
    maintenance_window_dow="monday",
    maintenance_window_time="10:00:00")

    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.NewClickhouse(ctx, "example_clickhouse", &aiven.ClickhouseArgs{
			Project:               pulumi.Any(exampleProject.Project),
			CloudName:             pulumi.String("google-europe-west1"),
			Plan:                  pulumi.String("business-4"),
			ServiceName:           pulumi.String("example-clickhouse-service"),
			MaintenanceWindowDow:  pulumi.String("monday"),
			MaintenanceWindowTime: pulumi.String("10:00:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleClickhouse = new Aiven.Clickhouse("example_clickhouse", new()
    {
        Project = exampleProject.Project,
        CloudName = "google-europe-west1",
        Plan = "business-4",
        ServiceName = "example-clickhouse-service",
        MaintenanceWindowDow = "monday",
        MaintenanceWindowTime = "10:00:00",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.Clickhouse;
import com.pulumi.aiven.ClickhouseArgs;
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) {
        var exampleClickhouse = new Clickhouse("exampleClickhouse", ClickhouseArgs.builder()
            .project(exampleProject.project())
            .cloudName("google-europe-west1")
            .plan("business-4")
            .serviceName("example-clickhouse-service")
            .maintenanceWindowDow("monday")
            .maintenanceWindowTime("10:00:00")
            .build());

    }
}

    resources:
  exampleClickhouse:
    type: aiven:Clickhouse
    name: example_clickhouse
    properties:
      project: ${exampleProject.project}
      cloudName: google-europe-west1
      plan: business-4
      serviceName: example-clickhouse-service
      maintenanceWindowDow: monday
      maintenanceWindowTime: 10:00:00

    Create Clickhouse Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Clickhouse(name: string, args: ClickhouseArgs, opts?: CustomResourceOptions);
    @overload
def Clickhouse(resource_name: str,
               args: ClickhouseArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Clickhouse(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               plan: Optional[str] = None,
               service_name: Optional[str] = None,
               project: Optional[str] = None,
               disk_space: Optional[str] = None,
               additional_disk_space: Optional[str] = None,
               maintenance_window_dow: Optional[str] = None,
               maintenance_window_time: Optional[str] = None,
               cloud_name: Optional[str] = None,
               clickhouse_user_config: Optional[ClickhouseClickhouseUserConfigArgs] = None,
               project_vpc_id: Optional[str] = None,
               service_integrations: Optional[Sequence[ClickhouseServiceIntegrationArgs]] = None,
               clickhouse: Optional[ClickhouseClickhouseArgs] = None,
               static_ips: Optional[Sequence[str]] = None,
               tags: Optional[Sequence[ClickhouseTagArgs]] = None,
               tech_emails: Optional[Sequence[ClickhouseTechEmailArgs]] = None,
               termination_protection: Optional[bool] = None)
    func NewClickhouse(ctx *Context, name string, args ClickhouseArgs, opts ...ResourceOption) (*Clickhouse, error)
    public Clickhouse(string name, ClickhouseArgs args, CustomResourceOptions? opts = null)
    public Clickhouse(String name, ClickhouseArgs args)
public Clickhouse(String name, ClickhouseArgs args, CustomResourceOptions options)

    type: aiven:Clickhouse
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClickhouseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClickhouseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClickhouseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClickhouseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClickhouseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clickhouseResource = new Aiven.Clickhouse("clickhouseResource", new()
{
    Plan = "string",
    ServiceName = "string",
    Project = "string",
    AdditionalDiskSpace = "string",
    MaintenanceWindowDow = "string",
    MaintenanceWindowTime = "string",
    CloudName = "string",
    ClickhouseUserConfig = new Aiven.Inputs.ClickhouseClickhouseUserConfigArgs
    {
        IpFilterObjects = new[]
        {
            new Aiven.Inputs.ClickhouseClickhouseUserConfigIpFilterObjectArgs
            {
                Network = "string",
                Description = "string",
            },
        },
        IpFilterStrings = new[]
        {
            "string",
        },
        PrivateAccess = new Aiven.Inputs.ClickhouseClickhouseUserConfigPrivateAccessArgs
        {
            Clickhouse = false,
            ClickhouseHttps = false,
            ClickhouseMysql = false,
            Prometheus = false,
        },
        PrivatelinkAccess = new Aiven.Inputs.ClickhouseClickhouseUserConfigPrivatelinkAccessArgs
        {
            Clickhouse = false,
            ClickhouseHttps = false,
            ClickhouseMysql = false,
            Prometheus = false,
        },
        ProjectToForkFrom = "string",
        PublicAccess = new Aiven.Inputs.ClickhouseClickhouseUserConfigPublicAccessArgs
        {
            Clickhouse = false,
            ClickhouseHttps = false,
            ClickhouseMysql = false,
            Prometheus = false,
        },
        RecoveryBasebackupName = "string",
        ServiceLog = false,
        ServiceToForkFrom = "string",
        StaticIps = false,
    },
    ProjectVpcId = "string",
    ServiceIntegrations = new[]
    {
        new Aiven.Inputs.ClickhouseServiceIntegrationArgs
        {
            IntegrationType = "string",
            SourceServiceName = "string",
        },
    },
    ClickhouseServer = new Aiven.Inputs.ClickhouseClickhouseArgs
    {
        Uris = new[]
        {
            "string",
        },
    },
    StaticIps = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Aiven.Inputs.ClickhouseTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TechEmails = new[]
    {
        new Aiven.Inputs.ClickhouseTechEmailArgs
        {
            Email = "string",
        },
    },
    TerminationProtection = false,
});

    example, err := aiven.NewClickhouse(ctx, "clickhouseResource", &aiven.ClickhouseArgs{
	Plan:                  pulumi.String("string"),
	ServiceName:           pulumi.String("string"),
	Project:               pulumi.String("string"),
	AdditionalDiskSpace:   pulumi.String("string"),
	MaintenanceWindowDow:  pulumi.String("string"),
	MaintenanceWindowTime: pulumi.String("string"),
	CloudName:             pulumi.String("string"),
	ClickhouseUserConfig: &aiven.ClickhouseClickhouseUserConfigArgs{
		IpFilterObjects: aiven.ClickhouseClickhouseUserConfigIpFilterObjectArray{
			&aiven.ClickhouseClickhouseUserConfigIpFilterObjectArgs{
				Network:     pulumi.String("string"),
				Description: pulumi.String("string"),
			},
		},
		IpFilterStrings: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrivateAccess: &aiven.ClickhouseClickhouseUserConfigPrivateAccessArgs{
			Clickhouse:      pulumi.Bool(false),
			ClickhouseHttps: pulumi.Bool(false),
			ClickhouseMysql: pulumi.Bool(false),
			Prometheus:      pulumi.Bool(false),
		},
		PrivatelinkAccess: &aiven.ClickhouseClickhouseUserConfigPrivatelinkAccessArgs{
			Clickhouse:      pulumi.Bool(false),
			ClickhouseHttps: pulumi.Bool(false),
			ClickhouseMysql: pulumi.Bool(false),
			Prometheus:      pulumi.Bool(false),
		},
		ProjectToForkFrom: pulumi.String("string"),
		PublicAccess: &aiven.ClickhouseClickhouseUserConfigPublicAccessArgs{
			Clickhouse:      pulumi.Bool(false),
			ClickhouseHttps: pulumi.Bool(false),
			ClickhouseMysql: pulumi.Bool(false),
			Prometheus:      pulumi.Bool(false),
		},
		RecoveryBasebackupName: pulumi.String("string"),
		ServiceLog:             pulumi.Bool(false),
		ServiceToForkFrom:      pulumi.String("string"),
		StaticIps:              pulumi.Bool(false),
	},
	ProjectVpcId: pulumi.String("string"),
	ServiceIntegrations: aiven.ClickhouseServiceIntegrationArray{
		&aiven.ClickhouseServiceIntegrationArgs{
			IntegrationType:   pulumi.String("string"),
			SourceServiceName: pulumi.String("string"),
		},
	},
	Clickhouse: &aiven.ClickhouseClickhouseArgs{
		Uris: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	StaticIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: aiven.ClickhouseTagArray{
		&aiven.ClickhouseTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TechEmails: aiven.ClickhouseTechEmailArray{
		&aiven.ClickhouseTechEmailArgs{
			Email: pulumi.String("string"),
		},
	},
	TerminationProtection: pulumi.Bool(false),
})

    var clickhouseResource = new Clickhouse("clickhouseResource", ClickhouseArgs.builder()
    .plan("string")
    .serviceName("string")
    .project("string")
    .additionalDiskSpace("string")
    .maintenanceWindowDow("string")
    .maintenanceWindowTime("string")
    .cloudName("string")
    .clickhouseUserConfig(ClickhouseClickhouseUserConfigArgs.builder()
        .ipFilterObjects(ClickhouseClickhouseUserConfigIpFilterObjectArgs.builder()
            .network("string")
            .description("string")
            .build())
        .ipFilterStrings("string")
        .privateAccess(ClickhouseClickhouseUserConfigPrivateAccessArgs.builder()
            .clickhouse(false)
            .clickhouseHttps(false)
            .clickhouseMysql(false)
            .prometheus(false)
            .build())
        .privatelinkAccess(ClickhouseClickhouseUserConfigPrivatelinkAccessArgs.builder()
            .clickhouse(false)
            .clickhouseHttps(false)
            .clickhouseMysql(false)
            .prometheus(false)
            .build())
        .projectToForkFrom("string")
        .publicAccess(ClickhouseClickhouseUserConfigPublicAccessArgs.builder()
            .clickhouse(false)
            .clickhouseHttps(false)
            .clickhouseMysql(false)
            .prometheus(false)
            .build())
        .recoveryBasebackupName("string")
        .serviceLog(false)
        .serviceToForkFrom("string")
        .staticIps(false)
        .build())
    .projectVpcId("string")
    .serviceIntegrations(ClickhouseServiceIntegrationArgs.builder()
        .integrationType("string")
        .sourceServiceName("string")
        .build())
    .clickhouse(ClickhouseClickhouseArgs.builder()
        .uris("string")
        .build())
    .staticIps("string")
    .tags(ClickhouseTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .techEmails(ClickhouseTechEmailArgs.builder()
        .email("string")
        .build())
    .terminationProtection(false)
    .build());

    clickhouse_resource = aiven.Clickhouse("clickhouseResource",
    plan="string",
    service_name="string",
    project="string",
    additional_disk_space="string",
    maintenance_window_dow="string",
    maintenance_window_time="string",
    cloud_name="string",
    clickhouse_user_config={
        "ip_filter_objects": [{
            "network": "string",
            "description": "string",
        }],
        "ip_filter_strings": ["string"],
        "private_access": {
            "clickhouse": False,
            "clickhouse_https": False,
            "clickhouse_mysql": False,
            "prometheus": False,
        },
        "privatelink_access": {
            "clickhouse": False,
            "clickhouse_https": False,
            "clickhouse_mysql": False,
            "prometheus": False,
        },
        "project_to_fork_from": "string",
        "public_access": {
            "clickhouse": False,
            "clickhouse_https": False,
            "clickhouse_mysql": False,
            "prometheus": False,
        },
        "recovery_basebackup_name": "string",
        "service_log": False,
        "service_to_fork_from": "string",
        "static_ips": False,
    },
    project_vpc_id="string",
    service_integrations=[{
        "integration_type": "string",
        "source_service_name": "string",
    }],
    clickhouse={
        "uris": ["string"],
    },
    static_ips=["string"],
    tags=[{
        "key": "string",
        "value": "string",
    }],
    tech_emails=[{
        "email": "string",
    }],
    termination_protection=False)

    const clickhouseResource = new aiven.Clickhouse("clickhouseResource", {
    plan: "string",
    serviceName: "string",
    project: "string",
    additionalDiskSpace: "string",
    maintenanceWindowDow: "string",
    maintenanceWindowTime: "string",
    cloudName: "string",
    clickhouseUserConfig: {
        ipFilterObjects: [{
            network: "string",
            description: "string",
        }],
        ipFilterStrings: ["string"],
        privateAccess: {
            clickhouse: false,
            clickhouseHttps: false,
            clickhouseMysql: false,
            prometheus: false,
        },
        privatelinkAccess: {
            clickhouse: false,
            clickhouseHttps: false,
            clickhouseMysql: false,
            prometheus: false,
        },
        projectToForkFrom: "string",
        publicAccess: {
            clickhouse: false,
            clickhouseHttps: false,
            clickhouseMysql: false,
            prometheus: false,
        },
        recoveryBasebackupName: "string",
        serviceLog: false,
        serviceToForkFrom: "string",
        staticIps: false,
    },
    projectVpcId: "string",
    serviceIntegrations: [{
        integrationType: "string",
        sourceServiceName: "string",
    }],
    clickhouse: {
        uris: ["string"],
    },
    staticIps: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
    techEmails: [{
        email: "string",
    }],
    terminationProtection: false,
});

    type: aiven:Clickhouse
properties:
    additionalDiskSpace: string
    clickhouse:
        uris:
            - string
    clickhouseUserConfig:
        ipFilterObjects:
            - description: string
              network: string
        ipFilterStrings:
            - string
        privateAccess:
            clickhouse: false
            clickhouseHttps: false
            clickhouseMysql: false
            prometheus: false
        privatelinkAccess:
            clickhouse: false
            clickhouseHttps: false
            clickhouseMysql: false
            prometheus: false
        projectToForkFrom: string
        publicAccess:
            clickhouse: false
            clickhouseHttps: false
            clickhouseMysql: false
            prometheus: false
        recoveryBasebackupName: string
        serviceLog: false
        serviceToForkFrom: string
        staticIps: false
    cloudName: string
    maintenanceWindowDow: string
    maintenanceWindowTime: string
    plan: string
    project: string
    projectVpcId: string
    serviceIntegrations:
        - integrationType: string
          sourceServiceName: string
    serviceName: string
    staticIps:
        - string
    tags:
        - key: string
          value: string
    techEmails:
        - email: string
    terminationProtection: false

    Clickhouse Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Clickhouse resource accepts the following input properties:

    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 seen from the Aiven pricing page.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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.
    AdditionalDiskSpace string
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    ClickhouseServer ClickhouseClickhouse
    Values provided by the ClickHouse server.
    ClickhouseUserConfig ClickhouseClickhouseUserConfig
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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.
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.
    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.
    ServiceIntegrations List<ClickhouseServiceIntegration>
    Integrations with other services. Service integrations are only applied at service creation.
    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<ClickhouseTag>
    Tags are key-value pairs that allow you to categorize services.
    TechEmails List<ClickhouseTechEmail>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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.
    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 seen from the Aiven pricing page.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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.
    AdditionalDiskSpace string
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    Clickhouse ClickhouseClickhouseArgs
    Values provided by the ClickHouse server.
    ClickhouseUserConfig ClickhouseClickhouseUserConfigArgs
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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.
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.
    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.
    ServiceIntegrations []ClickhouseServiceIntegrationArgs
    Integrations with other services. Service integrations are only applied at service creation.
    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 []ClickhouseTagArgs
    Tags are key-value pairs that allow you to categorize services.
    TechEmails []ClickhouseTechEmailArgs
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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.
    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 seen from the Aiven pricing page.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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.
    additionalDiskSpace String
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    clickhouse ClickhouseClickhouse
    Values provided by the ClickHouse server.
    clickhouseUserConfig ClickhouseClickhouseUserConfig
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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.
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.
    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.
    serviceIntegrations List<ClickhouseServiceIntegration>
    Integrations with other services. Service integrations are only applied at service creation.
    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<ClickhouseTag>
    Tags are key-value pairs that allow you to categorize services.
    techEmails List<ClickhouseTechEmail>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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.
    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 seen from the Aiven pricing page.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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.
    additionalDiskSpace string
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    clickhouse ClickhouseClickhouse
    Values provided by the ClickHouse server.
    clickhouseUserConfig ClickhouseClickhouseUserConfig
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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.
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.
    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.
    serviceIntegrations ClickhouseServiceIntegration[]
    Integrations with other services. Service integrations are only applied at service creation.
    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 ClickhouseTag[]
    Tags are key-value pairs that allow you to categorize services.
    techEmails ClickhouseTechEmail[]
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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.
    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 seen from the Aiven pricing page.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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.
    additional_disk_space str
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    clickhouse ClickhouseClickhouseArgs
    Values provided by the ClickHouse server.
    clickhouse_user_config ClickhouseClickhouseUserConfigArgs
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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.
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.
    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_integrations Sequence[ClickhouseServiceIntegrationArgs]
    Integrations with other services. Service integrations are only applied at service creation.
    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[ClickhouseTagArgs]
    Tags are key-value pairs that allow you to categorize services.
    tech_emails Sequence[ClickhouseTechEmailArgs]
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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.
    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 seen from the Aiven pricing page.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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.
    additionalDiskSpace String
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    clickhouse Property Map
    Values provided by the ClickHouse server.
    clickhouseUserConfig Property Map
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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.
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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.
    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.
    serviceIntegrations List<Property Map>
    Integrations with other services. Service integrations are only applied at service creation.
    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.
    techEmails List<Property Map>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Clickhouse resource produces the following output properties:

    Components List<ClickhouseComponent>
    Service component information objects
    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceHost string
    The hostname of the service.
    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
    Components []ClickhouseComponent
    Service component information objects
    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceHost string
    The hostname of the service.
    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
    components List<ClickhouseComponent>
    Service component information objects
    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    id String
    The provider-assigned unique ID for this managed resource.
    serviceHost String
    The hostname of the service.
    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
    components ClickhouseComponent[]
    Service component information objects
    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    id string
    The provider-assigned unique ID for this managed resource.
    serviceHost string
    The hostname of the service.
    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
    components Sequence[ClickhouseComponent]
    Service component information objects
    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    id str
    The provider-assigned unique ID for this managed resource.
    service_host str
    The hostname of the service.
    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
    components List<Property Map>
    Service component information objects
    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    id String
    The provider-assigned unique ID for this managed resource.
    serviceHost String
    The hostname of the service.
    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

    Look up Existing Clickhouse Resource

    Get an existing Clickhouse resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClickhouseState, opts?: CustomResourceOptions): Clickhouse
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_disk_space: Optional[str] = None,
        clickhouse: Optional[ClickhouseClickhouseArgs] = None,
        clickhouse_user_config: Optional[ClickhouseClickhouseUserConfigArgs] = None,
        cloud_name: Optional[str] = None,
        components: Optional[Sequence[ClickhouseComponentArgs]] = None,
        disk_space: Optional[str] = None,
        disk_space_cap: Optional[str] = None,
        disk_space_default: Optional[str] = None,
        disk_space_step: Optional[str] = None,
        disk_space_used: Optional[str] = None,
        maintenance_window_dow: Optional[str] = None,
        maintenance_window_time: Optional[str] = None,
        plan: Optional[str] = None,
        project: Optional[str] = None,
        project_vpc_id: Optional[str] = None,
        service_host: Optional[str] = None,
        service_integrations: Optional[Sequence[ClickhouseServiceIntegrationArgs]] = None,
        service_name: Optional[str] = None,
        service_password: Optional[str] = None,
        service_port: Optional[int] = None,
        service_type: Optional[str] = None,
        service_uri: Optional[str] = None,
        service_username: Optional[str] = None,
        state: Optional[str] = None,
        static_ips: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[ClickhouseTagArgs]] = None,
        tech_emails: Optional[Sequence[ClickhouseTechEmailArgs]] = None,
        termination_protection: Optional[bool] = None) -> Clickhouse
    func GetClickhouse(ctx *Context, name string, id IDInput, state *ClickhouseState, opts ...ResourceOption) (*Clickhouse, error)
    public static Clickhouse Get(string name, Input<string> id, ClickhouseState? state, CustomResourceOptions? opts = null)
    public static Clickhouse get(String name, Output<String> id, ClickhouseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdditionalDiskSpace string
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    ClickhouseServer ClickhouseClickhouse
    Values provided by the ClickHouse server.
    ClickhouseUserConfig ClickhouseClickhouseUserConfig
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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<ClickhouseComponent>
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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<ClickhouseServiceIntegration>
    Integrations with other services. Service integrations are only applied at 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<ClickhouseTag>
    Tags are key-value pairs that allow you to categorize services.
    TechEmails List<ClickhouseTechEmail>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    Clickhouse ClickhouseClickhouseArgs
    Values provided by the ClickHouse server.
    ClickhouseUserConfig ClickhouseClickhouseUserConfigArgs
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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 []ClickhouseComponentArgs
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    MaintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    MaintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    Plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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 []ClickhouseServiceIntegrationArgs
    Integrations with other services. Service integrations are only applied at 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 []ClickhouseTagArgs
    Tags are key-value pairs that allow you to categorize services.
    TechEmails []ClickhouseTechEmailArgs
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    clickhouse ClickhouseClickhouse
    Values provided by the ClickHouse server.
    clickhouseUserConfig ClickhouseClickhouseUserConfig
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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<ClickhouseComponent>
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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<ClickhouseServiceIntegration>
    Integrations with other services. Service integrations are only applied at 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<ClickhouseTag>
    Tags are key-value pairs that allow you to categorize services.
    techEmails List<ClickhouseTechEmail>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    clickhouse ClickhouseClickhouse
    Values provided by the ClickHouse server.
    clickhouseUserConfig ClickhouseClickhouseUserConfig
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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 ClickhouseComponent[]
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenanceWindowDow string
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime string
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan string
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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 ClickhouseServiceIntegration[]
    Integrations with other services. Service integrations are only applied at 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 ClickhouseTag[]
    Tags are key-value pairs that allow you to categorize services.
    techEmails ClickhouseTechEmail[]
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    clickhouse ClickhouseClickhouseArgs
    Values provided by the ClickHouse server.
    clickhouse_user_config ClickhouseClickhouseUserConfigArgs
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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[ClickhouseComponentArgs]
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenance_window_dow str
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenance_window_time str
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan str
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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[ClickhouseServiceIntegrationArgs]
    Integrations with other services. Service integrations are only applied at 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[ClickhouseTagArgs]
    Tags are key-value pairs that allow you to categorize services.
    tech_emails Sequence[ClickhouseTechEmailArgs]
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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
    Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart and there might be a short downtime for services with no HA capabilities.
    clickhouse Property Map
    Values provided by the ClickHouse server.
    clickhouseUserConfig Property Map
    Clickhouse user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
    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.

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    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

    Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

    maintenanceWindowDow String
    Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
    maintenanceWindowTime String
    Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
    plan String
    Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property 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>
    Integrations with other services. Service integrations are only applied at 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.
    techEmails List<Property Map>
    The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
    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

    ClickhouseClickhouse, ClickhouseClickhouseArgs

    Uris List<string>
    ClickHouse server URIs.
    Uris []string
    ClickHouse server URIs.
    uris List<String>
    ClickHouse server URIs.
    uris string[]
    ClickHouse server URIs.
    uris Sequence[str]
    ClickHouse server URIs.
    uris List<String>
    ClickHouse server URIs.

    ClickhouseClickhouseUserConfig, ClickhouseClickhouseUserConfigArgs

    AdditionalBackupRegions string
    Additional Cloud Regions for Backup Replication.

    Deprecated: This property is deprecated.

    IpFilterObjects List<ClickhouseClickhouseUserConfigIpFilterObject>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    IpFilterStrings List<string>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    IpFilters List<string>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    PrivateAccess ClickhouseClickhouseUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    PrivatelinkAccess ClickhouseClickhouseUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    ProjectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    PublicAccess ClickhouseClickhouseUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    RecoveryBasebackupName string
    Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
    ServiceLog bool
    Store logs for the service so that they are available in the HTTP API and console.
    ServiceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    StaticIps bool
    Use static public IP addresses.
    AdditionalBackupRegions string
    Additional Cloud Regions for Backup Replication.

    Deprecated: This property is deprecated.

    IpFilterObjects []ClickhouseClickhouseUserConfigIpFilterObject
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    IpFilterStrings []string
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    IpFilters []string
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    PrivateAccess ClickhouseClickhouseUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    PrivatelinkAccess ClickhouseClickhouseUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    ProjectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    PublicAccess ClickhouseClickhouseUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    RecoveryBasebackupName string
    Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
    ServiceLog bool
    Store logs for the service so that they are available in the HTTP API and console.
    ServiceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    StaticIps bool
    Use static public IP addresses.
    additionalBackupRegions String
    Additional Cloud Regions for Backup Replication.

    Deprecated: This property is deprecated.

    ipFilterObjects List<ClickhouseClickhouseUserConfigIpFilterObject>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    ipFilterStrings List<String>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    ipFilters List<String>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    privateAccess ClickhouseClickhouseUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelinkAccess ClickhouseClickhouseUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    projectToForkFrom String
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    publicAccess ClickhouseClickhouseUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recoveryBasebackupName String
    Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
    serviceLog Boolean
    Store logs for the service so that they are available in the HTTP API and console.
    serviceToForkFrom String
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    staticIps Boolean
    Use static public IP addresses.
    additionalBackupRegions string
    Additional Cloud Regions for Backup Replication.

    Deprecated: This property is deprecated.

    ipFilterObjects ClickhouseClickhouseUserConfigIpFilterObject[]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    ipFilterStrings string[]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    ipFilters string[]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    privateAccess ClickhouseClickhouseUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelinkAccess ClickhouseClickhouseUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    projectToForkFrom string
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    publicAccess ClickhouseClickhouseUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recoveryBasebackupName string
    Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
    serviceLog boolean
    Store logs for the service so that they are available in the HTTP API and console.
    serviceToForkFrom string
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    staticIps boolean
    Use static public IP addresses.
    additional_backup_regions str
    Additional Cloud Regions for Backup Replication.

    Deprecated: This property is deprecated.

    ip_filter_objects Sequence[ClickhouseClickhouseUserConfigIpFilterObject]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    ip_filter_strings Sequence[str]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    ip_filters Sequence[str]
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    private_access ClickhouseClickhouseUserConfigPrivateAccess
    Allow access to selected service ports from private networks
    privatelink_access ClickhouseClickhouseUserConfigPrivatelinkAccess
    Allow access to selected service components through Privatelink
    project_to_fork_from str
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    public_access ClickhouseClickhouseUserConfigPublicAccess
    Allow access to selected service ports from the public Internet
    recovery_basebackup_name str
    Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
    service_log bool
    Store logs for the service so that they are available in the HTTP API and console.
    service_to_fork_from str
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    static_ips bool
    Use static public IP addresses.
    additionalBackupRegions String
    Additional Cloud Regions for Backup Replication.

    Deprecated: This property is deprecated.

    ipFilterObjects List<Property Map>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
    ipFilterStrings List<String>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
    ipFilters List<String>
    Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

    Deprecated: Deprecated. Use ip_filter_string instead.

    privateAccess Property Map
    Allow access to selected service ports from private networks
    privatelinkAccess Property Map
    Allow access to selected service components through Privatelink
    projectToForkFrom String
    Name of another project to fork a service from. This has effect only when a new service is being created. Example: anotherprojectname.
    publicAccess Property Map
    Allow access to selected service ports from the public Internet
    recoveryBasebackupName String
    Name of the basebackup to restore in forked service. Example: backup-20191112t091354293891z.
    serviceLog Boolean
    Store logs for the service so that they are available in the HTTP API and console.
    serviceToForkFrom String
    Name of another service to fork from. This has effect only when a new service is being created. Example: anotherservicename.
    staticIps Boolean
    Use static public IP addresses.

    ClickhouseClickhouseUserConfigIpFilterObject, ClickhouseClickhouseUserConfigIpFilterObjectArgs

    Network string
    CIDR address block. Example: 10.20.0.0/16.
    Description string
    Description for IP filter list entry. Example: Production service IP range.
    Network string
    CIDR address block. Example: 10.20.0.0/16.
    Description string
    Description for IP filter list entry. Example: Production service IP range.
    network String
    CIDR address block. Example: 10.20.0.0/16.
    description String
    Description for IP filter list entry. Example: Production service IP range.
    network string
    CIDR address block. Example: 10.20.0.0/16.
    description string
    Description for IP filter list entry. Example: Production service IP range.
    network str
    CIDR address block. Example: 10.20.0.0/16.
    description str
    Description for IP filter list entry. Example: Production service IP range.
    network String
    CIDR address block. Example: 10.20.0.0/16.
    description String
    Description for IP filter list entry. Example: Production service IP range.

    ClickhouseClickhouseUserConfigPrivateAccess, ClickhouseClickhouseUserConfigPrivateAccessArgs

    Clickhouse bool
    Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    ClickhouseHttps bool
    Allow clients to connect to clickhouse_https with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    ClickhouseMysql bool
    Allow clients to connect to clickhouse_mysql with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    Prometheus bool
    Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    Clickhouse bool
    Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    ClickhouseHttps bool
    Allow clients to connect to clickhouse_https with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    ClickhouseMysql bool
    Allow clients to connect to clickhouse_mysql with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    Prometheus bool
    Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouse Boolean
    Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouseHttps Boolean
    Allow clients to connect to clickhouse_https with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouseMysql Boolean
    Allow clients to connect to clickhouse_mysql with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    prometheus Boolean
    Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouse boolean
    Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouseHttps boolean
    Allow clients to connect to clickhouse_https with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouseMysql boolean
    Allow clients to connect to clickhouse_mysql with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    prometheus boolean
    Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouse bool
    Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouse_https bool
    Allow clients to connect to clickhouse_https with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouse_mysql bool
    Allow clients to connect to clickhouse_mysql with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    prometheus bool
    Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouse Boolean
    Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouseHttps Boolean
    Allow clients to connect to clickhouse_https with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    clickhouseMysql Boolean
    Allow clients to connect to clickhouse_mysql with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.
    prometheus Boolean
    Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations.

    ClickhouseClickhouseUserConfigPrivatelinkAccess, ClickhouseClickhouseUserConfigPrivatelinkAccessArgs

    Clickhouse bool
    Enable clickhouse.
    ClickhouseHttps bool
    Enable clickhouse_https.
    ClickhouseMysql bool
    Enable clickhouse_mysql.
    Prometheus bool
    Enable prometheus.
    Clickhouse bool
    Enable clickhouse.
    ClickhouseHttps bool
    Enable clickhouse_https.
    ClickhouseMysql bool
    Enable clickhouse_mysql.
    Prometheus bool
    Enable prometheus.
    clickhouse Boolean
    Enable clickhouse.
    clickhouseHttps Boolean
    Enable clickhouse_https.
    clickhouseMysql Boolean
    Enable clickhouse_mysql.
    prometheus Boolean
    Enable prometheus.
    clickhouse boolean
    Enable clickhouse.
    clickhouseHttps boolean
    Enable clickhouse_https.
    clickhouseMysql boolean
    Enable clickhouse_mysql.
    prometheus boolean
    Enable prometheus.
    clickhouse bool
    Enable clickhouse.
    clickhouse_https bool
    Enable clickhouse_https.
    clickhouse_mysql bool
    Enable clickhouse_mysql.
    prometheus bool
    Enable prometheus.
    clickhouse Boolean
    Enable clickhouse.
    clickhouseHttps Boolean
    Enable clickhouse_https.
    clickhouseMysql Boolean
    Enable clickhouse_mysql.
    prometheus Boolean
    Enable prometheus.

    ClickhouseClickhouseUserConfigPublicAccess, ClickhouseClickhouseUserConfigPublicAccessArgs

    Clickhouse bool
    Allow clients to connect to clickhouse from the public internet for service nodes that are in a project VPC or another type of private network.
    ClickhouseHttps bool
    Allow clients to connect to clickhouse_https from the public internet for service nodes that are in a project VPC or another type of private network.
    ClickhouseMysql bool
    Allow clients to connect to clickhouse_mysql from the public internet for service nodes that are in a project VPC or another type of private network.
    Prometheus bool
    Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
    Clickhouse bool
    Allow clients to connect to clickhouse from the public internet for service nodes that are in a project VPC or another type of private network.
    ClickhouseHttps bool
    Allow clients to connect to clickhouse_https from the public internet for service nodes that are in a project VPC or another type of private network.
    ClickhouseMysql bool
    Allow clients to connect to clickhouse_mysql from the public internet for service nodes that are in a project VPC or another type of private network.
    Prometheus bool
    Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouse Boolean
    Allow clients to connect to clickhouse from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouseHttps Boolean
    Allow clients to connect to clickhouse_https from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouseMysql Boolean
    Allow clients to connect to clickhouse_mysql from the public internet for service nodes that are in a project VPC or another type of private network.
    prometheus Boolean
    Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouse boolean
    Allow clients to connect to clickhouse from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouseHttps boolean
    Allow clients to connect to clickhouse_https from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouseMysql boolean
    Allow clients to connect to clickhouse_mysql from the public internet for service nodes that are in a project VPC or another type of private network.
    prometheus boolean
    Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouse bool
    Allow clients to connect to clickhouse from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouse_https bool
    Allow clients to connect to clickhouse_https from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouse_mysql bool
    Allow clients to connect to clickhouse_mysql from the public internet for service nodes that are in a project VPC or another type of private network.
    prometheus bool
    Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouse Boolean
    Allow clients to connect to clickhouse from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouseHttps Boolean
    Allow clients to connect to clickhouse_https from the public internet for service nodes that are in a project VPC or another type of private network.
    clickhouseMysql Boolean
    Allow clients to connect to clickhouse_mysql from the public internet for service nodes that are in a project VPC or another type of private network.
    prometheus Boolean
    Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network.

    ClickhouseComponent, ClickhouseComponentArgs

    Component string
    Service component name
    ConnectionUri string
    Connection info for connecting to the service component. This is a combination of host and port.
    Host string
    Host name for connecting to the service component
    KafkaAuthenticationMethod string
    Kafka authentication method. This is a value specific to the 'kafka' service component
    Port int
    Port number for connecting to the service component
    Route string
    Network access route
    Ssl bool
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    Usage string
    DNS usage name
    Component string
    Service component name
    ConnectionUri string
    Connection info for connecting to the service component. This is a combination of host and port.
    Host string
    Host name for connecting to the service component
    KafkaAuthenticationMethod string
    Kafka authentication method. This is a value specific to the 'kafka' service component
    Port int
    Port number for connecting to the service component
    Route string
    Network access route
    Ssl bool
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    Usage string
    DNS usage name
    component String
    Service component name
    connectionUri String
    Connection info for connecting to the service component. This is a combination of host and port.
    host String
    Host name for connecting to the service component
    kafkaAuthenticationMethod String
    Kafka authentication method. This is a value specific to the 'kafka' service component
    port Integer
    Port number for connecting to the service component
    route String
    Network access route
    ssl Boolean
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    usage String
    DNS usage name
    component string
    Service component name
    connectionUri string
    Connection info for connecting to the service component. This is a combination of host and port.
    host string
    Host name for connecting to the service component
    kafkaAuthenticationMethod string
    Kafka authentication method. This is a value specific to the 'kafka' service component
    port number
    Port number for connecting to the service component
    route string
    Network access route
    ssl boolean
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    usage string
    DNS usage name
    component str
    Service component name
    connection_uri str
    Connection info for connecting to the service component. This is a combination of host and port.
    host str
    Host name for connecting to the service component
    kafka_authentication_method str
    Kafka authentication method. This is a value specific to the 'kafka' service component
    port int
    Port number for connecting to the service component
    route str
    Network access route
    ssl bool
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    usage str
    DNS usage name
    component String
    Service component name
    connectionUri String
    Connection info for connecting to the service component. This is a combination of host and port.
    host String
    Host name for connecting to the service component
    kafkaAuthenticationMethod String
    Kafka authentication method. This is a value specific to the 'kafka' service component
    port Number
    Port number for connecting to the service component
    route String
    Network access route
    ssl Boolean
    Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
    usage String
    DNS usage name

    ClickhouseServiceIntegration, ClickhouseServiceIntegrationArgs

    IntegrationType string
    Type of the service integration. Supported integrations are clickhouse_kafka and clickhouse_postgresql.
    SourceServiceName string
    Name of the source service.
    IntegrationType string
    Type of the service integration. Supported integrations are clickhouse_kafka and clickhouse_postgresql.
    SourceServiceName string
    Name of the source service.
    integrationType String
    Type of the service integration. Supported integrations are clickhouse_kafka and clickhouse_postgresql.
    sourceServiceName String
    Name of the source service.
    integrationType string
    Type of the service integration. Supported integrations are clickhouse_kafka and clickhouse_postgresql.
    sourceServiceName string
    Name of the source service.
    integration_type str
    Type of the service integration. Supported integrations are clickhouse_kafka and clickhouse_postgresql.
    source_service_name str
    Name of the source service.
    integrationType String
    Type of the service integration. Supported integrations are clickhouse_kafka and clickhouse_postgresql.
    sourceServiceName String
    Name of the source service.

    ClickhouseTag, ClickhouseTagArgs

    Key string
    Service tag key
    Value string
    Service tag value
    Key string
    Service tag key
    Value string
    Service tag value
    key String
    Service tag key
    value String
    Service tag value
    key string
    Service tag key
    value string
    Service tag value
    key str
    Service tag key
    value str
    Service tag value
    key String
    Service tag key
    value String
    Service tag value

    ClickhouseTechEmail, ClickhouseTechEmailArgs

    Email string
    An email address to contact for technical issues
    Email string
    An email address to contact for technical issues
    email String
    An email address to contact for technical issues
    email string
    An email address to contact for technical issues
    email str
    An email address to contact for technical issues
    email String
    An email address to contact for technical issues

    Import

    $ pulumi import aiven:index/clickhouse:Clickhouse clickhouse PROJECT/SERVICE_NAME

    To learn more about importing existing cloud resources, see Importing resources.

    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.28.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-aiven