aiven.getClickhouse
Explore with Pulumi AI
The Clickhouse data source provides information about the existing Aiven Clickhouse service.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var clickhouse = Aiven.GetClickhouse.Invoke(new()
{
Project = data.Aiven_project.Pr1.Project,
ServiceName = "<SERVICE_NAME>",
});
});
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.LookupClickhouse(ctx, &aiven.LookupClickhouseArgs{
Project: data.Aiven_project.Pr1.Project,
ServiceName: "<SERVICE_NAME>",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetClickhouseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var clickhouse = AivenFunctions.getClickhouse(GetClickhouseArgs.builder()
.project(data.aiven_project().pr1().project())
.serviceName("<SERVICE_NAME>")
.build());
}
}
import pulumi
import pulumi_aiven as aiven
clickhouse = aiven.get_clickhouse(project=data["aiven_project"]["pr1"]["project"],
service_name="<SERVICE_NAME>")
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const clickhouse = aiven.getClickhouse({
project: data.aiven_project.pr1.project,
serviceName: "<SERVICE_NAME>",
});
variables:
clickhouse:
fn::invoke:
Function: aiven:getClickhouse
Arguments:
project: ${data.aiven_project.pr1.project}
serviceName: <SERVICE_NAME>
Using getClickhouse
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getClickhouse(args: GetClickhouseArgs, opts?: InvokeOptions): Promise<GetClickhouseResult>
function getClickhouseOutput(args: GetClickhouseOutputArgs, opts?: InvokeOptions): Output<GetClickhouseResult>
def get_clickhouse(project: Optional[str] = None,
service_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetClickhouseResult
def get_clickhouse_output(project: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClickhouseResult]
func LookupClickhouse(ctx *Context, args *LookupClickhouseArgs, opts ...InvokeOption) (*LookupClickhouseResult, error)
func LookupClickhouseOutput(ctx *Context, args *LookupClickhouseOutputArgs, opts ...InvokeOption) LookupClickhouseResultOutput
> Note: This function is named LookupClickhouse
in the Go SDK.
public static class GetClickhouse
{
public static Task<GetClickhouseResult> InvokeAsync(GetClickhouseArgs args, InvokeOptions? opts = null)
public static Output<GetClickhouseResult> Invoke(GetClickhouseInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClickhouseResult> getClickhouse(GetClickhouseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aiven:index/getClickhouse:getClickhouse
arguments:
# arguments dictionary
The following arguments are supported:
- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name String Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project str
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service_
name str Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- service
Name String Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
getClickhouse Result
The following output properties are available:
- Additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Clickhouse
User List<GetConfigs Clickhouse Clickhouse User Config> Clickhouse user configurable settings
- Clickhouses
List<Get
Clickhouse Clickhouse> Clickhouse server provided values
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- Components
List<Get
Clickhouse Component> Service component information objects
- Disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- Disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- Disk
Space stringUsed Disk space that service is currently using
- Id string
The provider-assigned unique ID for this managed resource.
- Maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Host string The hostname of the service.
- Service
Integrations List<GetClickhouse Service Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Service
Password string Password used for connecting to the service, if applicable
- Service
Port int The port of the service
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string Username used for connecting to the service, if applicable
- State string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips List<string> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Get
Clickhouse Tag> Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool Prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- Additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Clickhouse
User []GetConfigs Clickhouse Clickhouse User Config Clickhouse user configurable settings
- Clickhouses
[]Get
Clickhouse Clickhouse Clickhouse server provided values
- Cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- Components
[]Get
Clickhouse Component Service component information objects
- Disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- Disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- Disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- Disk
Space stringUsed Disk space that service is currently using
- Id string
The provider-assigned unique ID for this managed resource.
- Maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- Project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- Project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- Service
Host string The hostname of the service.
- Service
Integrations []GetClickhouse Service Integration Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- Service
Password string Password used for connecting to the service, if applicable
- Service
Port int The port of the service
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string Username used for connecting to the service, if applicable
- State string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips []string Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- []Get
Clickhouse Tag Tags are key-value pairs that allow you to categorize services.
- Termination
Protection bool Prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional
Disk StringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- clickhouse
User List<GetConfigs Clickhouse Clickhouse User Config> Clickhouse user configurable settings
- clickhouses
List<Get
Clickhouse Clickhouse> Clickhouse server provided values
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- components
List<Get
Clickhouse Component> Service component information objects
- disk
Space String Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space StringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space StringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space StringUsed Disk space that service is currently using
- id String
The provider-assigned unique ID for this managed resource.
- maintenance
Window StringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host String The hostname of the service.
- service
Integrations List<GetClickhouse Service Integration> Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name String Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password String Password used for connecting to the service, if applicable
- service
Port Integer The port of the service
- service
Type String Aiven internal service type code
- service
Uri String URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String Username used for connecting to the service, if applicable
- state String
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips List<String> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Get
Clickhouse Tag> Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean Prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional
Disk stringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- clickhouse
User GetConfigs Clickhouse Clickhouse User Config[] Clickhouse user configurable settings
- clickhouses
Get
Clickhouse Clickhouse[] Clickhouse server provided values
- cloud
Name string Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- components
Get
Clickhouse Component[] Service component information objects
- disk
Space string Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space stringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space stringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space stringUsed Disk space that service is currently using
- id string
The provider-assigned unique ID for this managed resource.
- maintenance
Window stringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- project string
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc stringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host string The hostname of the service.
- service
Integrations GetClickhouse Service Integration[] Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name string Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password string Password used for connecting to the service, if applicable
- service
Port number The port of the service
- service
Type string Aiven internal service type code
- service
Uri string URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string Username used for connecting to the service, if applicable
- state string
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips string[] Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- Get
Clickhouse Tag[] Tags are key-value pairs that allow you to categorize services.
- termination
Protection boolean Prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional_
disk_ strspace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- clickhouse_
user_ Sequence[Getconfigs Clickhouse Clickhouse User Config] Clickhouse user configurable settings
- clickhouses
Sequence[Get
Clickhouse Clickhouse] Clickhouse server provided values
- cloud_
name str Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- components
Sequence[Get
Clickhouse Component] Service component information objects
- disk_
space str Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk_
space_ strcap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk_
space_ strstep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk_
space_ strused Disk space that service is currently using
- id str
The provider-assigned unique ID for this managed resource.
- maintenance_
window_ strdow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- project str
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project_
vpc_ strid Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service_
host str The hostname of the service.
- service_
integrations Sequence[GetClickhouse Service Integration] Service integrations to specify when creating a service. Not applied after initial service creation
- service_
name str Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service_
password str Password used for connecting to the service, if applicable
- service_
port int The port of the service
- service_
type str Aiven internal service type code
- service_
uri str URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service_
username str Username used for connecting to the service, if applicable
- state str
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static_
ips Sequence[str] Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- Sequence[Get
Clickhouse Tag] Tags are key-value pairs that allow you to categorize services.
- termination_
protection bool Prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
- additional
Disk StringSpace Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- clickhouse
User List<Property Map>Configs Clickhouse user configurable settings
- clickhouses List<Property Map>
Clickhouse server provided values
- cloud
Name String Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS.- components List<Property Map>
Service component information objects
- disk
Space String Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
- disk
Space StringCap The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for
disk_space
- disk
Space StringStep The default disk space step of the service, possible values depend on the service type, the cloud provider and the project.
disk_space
needs to increment fromdisk_space_default
by increments of this size.- disk
Space StringUsed Disk space that service is currently using
- id String
The provider-assigned unique ID for this managed resource.
- maintenance
Window StringDow Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are
hobbyist
,startup-x
,business-x
andpremium-x
wherex
is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.- project String
Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- project
Vpc StringId Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
- service
Host String The hostname of the service.
- service
Integrations List<Property Map> Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name String Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
- service
Password String Password used for connecting to the service, if applicable
- service
Port Number The port of the service
- service
Type String Aiven internal service type code
- service
Uri String URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String Username used for connecting to the service, if applicable
- state String
Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips List<String> Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
- List<Property Map>
Tags are key-value pairs that allow you to categorize services.
- termination
Protection Boolean Prevents the service from being deleted. It is recommended to set this to
true
for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Supporting Types
GetClickhouseClickhouseUserConfig
- Additional
Backup stringRegions - Ip
Filter List<GetObjects Clickhouse Clickhouse User Config Ip Filter Object> - Ip
Filter List<string>Strings - Ip
Filters List<string> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- Private
Access GetClickhouse Clickhouse User Config Private Access - Privatelink
Access GetClickhouse Clickhouse User Config Privatelink Access - Project
To stringFork From - Public
Access GetClickhouse Clickhouse User Config Public Access - Service
To stringFork From - Static
Ips bool 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
- Additional
Backup stringRegions - Ip
Filter []GetObjects Clickhouse Clickhouse User Config Ip Filter Object - Ip
Filter []stringStrings - Ip
Filters []string This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- Private
Access GetClickhouse Clickhouse User Config Private Access - Privatelink
Access GetClickhouse Clickhouse User Config Privatelink Access - Project
To stringFork From - Public
Access GetClickhouse Clickhouse User Config Public Access - Service
To stringFork From - Static
Ips bool 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
- additional
Backup StringRegions - ip
Filter List<GetObjects Clickhouse Clickhouse User Config Ip Filter Object> - ip
Filter List<String>Strings - ip
Filters List<String> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- private
Access GetClickhouse Clickhouse User Config Private Access - privatelink
Access GetClickhouse Clickhouse User Config Privatelink Access - project
To StringFork From - public
Access GetClickhouse Clickhouse User Config Public Access - service
To StringFork From - static
Ips Boolean 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
- additional
Backup stringRegions - ip
Filter GetObjects Clickhouse Clickhouse User Config Ip Filter Object[] - ip
Filter string[]Strings - ip
Filters string[] This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- private
Access GetClickhouse Clickhouse User Config Private Access - privatelink
Access GetClickhouse Clickhouse User Config Privatelink Access - project
To stringFork From - public
Access GetClickhouse Clickhouse User Config Public Access - service
To stringFork From - static
Ips boolean 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
- additional_
backup_ strregions - ip_
filter_ Sequence[Getobjects Clickhouse Clickhouse User Config Ip Filter Object] - ip_
filter_ Sequence[str]strings - ip_
filters Sequence[str] This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- private_
access GetClickhouse Clickhouse User Config Private Access - privatelink_
access GetClickhouse Clickhouse User Config Privatelink Access - project_
to_ strfork_ from - public_
access GetClickhouse Clickhouse User Config Public Access - service_
to_ strfork_ from - static_
ips bool 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
- additional
Backup StringRegions - ip
Filter List<Property Map>Objects - ip
Filter List<String>Strings - ip
Filters List<String> This will be removed in v5.0.0 and replaced with ip_filter_string instead.
- private
Access Property Map - privatelink
Access Property Map - project
To StringFork From - public
Access Property Map - service
To StringFork From - static
Ips Boolean 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
GetClickhouseClickhouseUserConfigIpFilterObject
- Network string
- Description string
- Network string
- Description string
- network String
- description String
- network string
- description string
- network str
- description str
- network String
- description String
GetClickhouseClickhouseUserConfigPrivateAccess
- Clickhouse bool
Clickhouse server provided values
- Clickhouse
Https bool - Prometheus bool
- Clickhouse bool
Clickhouse server provided values
- Clickhouse
Https bool - Prometheus bool
- clickhouse Boolean
Clickhouse server provided values
- clickhouse
Https Boolean - prometheus Boolean
- clickhouse boolean
Clickhouse server provided values
- clickhouse
Https boolean - prometheus boolean
- clickhouse bool
Clickhouse server provided values
- clickhouse_
https bool - prometheus bool
- clickhouse Boolean
Clickhouse server provided values
- clickhouse
Https Boolean - prometheus Boolean
GetClickhouseClickhouseUserConfigPrivatelinkAccess
- Clickhouse bool
Clickhouse server provided values
- Clickhouse
Https bool - Prometheus bool
- Clickhouse bool
Clickhouse server provided values
- Clickhouse
Https bool - Prometheus bool
- clickhouse Boolean
Clickhouse server provided values
- clickhouse
Https Boolean - prometheus Boolean
- clickhouse boolean
Clickhouse server provided values
- clickhouse
Https boolean - prometheus boolean
- clickhouse bool
Clickhouse server provided values
- clickhouse_
https bool - prometheus bool
- clickhouse Boolean
Clickhouse server provided values
- clickhouse
Https Boolean - prometheus Boolean
GetClickhouseClickhouseUserConfigPublicAccess
- Clickhouse bool
Clickhouse server provided values
- Clickhouse
Https bool - Prometheus bool
- Clickhouse bool
Clickhouse server provided values
- Clickhouse
Https bool - Prometheus bool
- clickhouse Boolean
Clickhouse server provided values
- clickhouse
Https Boolean - prometheus Boolean
- clickhouse boolean
Clickhouse server provided values
- clickhouse
Https boolean - prometheus boolean
- clickhouse bool
Clickhouse server provided values
- clickhouse_
https bool - prometheus bool
- clickhouse Boolean
Clickhouse server provided values
- clickhouse
Https Boolean - prometheus Boolean
GetClickhouseComponent
GetClickhouseServiceIntegration
- Integration
Type string - Source
Service stringName
- Integration
Type string - Source
Service stringName
- integration
Type String - source
Service StringName
- integration
Type string - source
Service stringName
- integration
Type String - source
Service StringName
GetClickhouseTag
Package Details
- Repository
- Aiven pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aiven
Terraform Provider.