Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Clickhouse
  3. API Docs
  4. Service
Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
pulumiverse/pulumi-clickhouse

clickhouse.Service

Explore with Pulumi AI

clickhouse logo
Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
pulumiverse/pulumi-clickhouse

    You can use the clickhouse_service resource to deploy ClickHouse cloud instances on supported cloud providers.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as clickhouse from "@pulumiverse/clickhouse";

const service = new clickhouse.Service("service", {
    cloudProvider: "aws",
    idleScaling: true,
    idleTimeoutMinutes: 5,
    ipAccesses: [{
        description: "Test IP",
        source: "192.168.2.63",
    }],
    maxTotalMemoryGb: 360,
    minTotalMemoryGb: 24,
    passwordHash: "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    region: "us-east-1",
    tier: "production",
});

    import pulumi
import pulumiverse_clickhouse as clickhouse

service = clickhouse.Service("service",
    cloud_provider="aws",
    idle_scaling=True,
    idle_timeout_minutes=5,
    ip_accesses=[{
        "description": "Test IP",
        "source": "192.168.2.63",
    }],
    max_total_memory_gb=360,
    min_total_memory_gb=24,
    password_hash="n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
    region="us-east-1",
    tier="production")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-clickhouse/sdk/go/clickhouse"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := clickhouse.NewService(ctx, "service", &clickhouse.ServiceArgs{
			CloudProvider:      pulumi.String("aws"),
			IdleScaling:        pulumi.Bool(true),
			IdleTimeoutMinutes: pulumi.Int(5),
			IpAccesses: clickhouse.ServiceIpAccessArray{
				&clickhouse.ServiceIpAccessArgs{
					Description: pulumi.String("Test IP"),
					Source:      pulumi.String("192.168.2.63"),
				},
			},
			MaxTotalMemoryGb: pulumi.Int(360),
			MinTotalMemoryGb: pulumi.Int(24),
			PasswordHash:     pulumi.String("n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg="),
			Region:           pulumi.String("us-east-1"),
			Tier:             pulumi.String("production"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Clickhouse = Pulumiverse.Clickhouse;

return await Deployment.RunAsync(() => 
{
    var service = new Clickhouse.Service("service", new()
    {
        CloudProvider = "aws",
        IdleScaling = true,
        IdleTimeoutMinutes = 5,
        IpAccesses = new[]
        {
            new Clickhouse.Inputs.ServiceIpAccessArgs
            {
                Description = "Test IP",
                Source = "192.168.2.63",
            },
        },
        MaxTotalMemoryGb = 360,
        MinTotalMemoryGb = 24,
        PasswordHash = "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
        Region = "us-east-1",
        Tier = "production",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.clickhouse.Service;
import com.pulumi.clickhouse.ServiceArgs;
import com.pulumi.clickhouse.inputs.ServiceIpAccessArgs;
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 service = new Service("service", ServiceArgs.builder()
            .cloudProvider("aws")
            .idleScaling(true)
            .idleTimeoutMinutes(5)
            .ipAccesses(ServiceIpAccessArgs.builder()
                .description("Test IP")
                .source("192.168.2.63")
                .build())
            .maxTotalMemoryGb(360)
            .minTotalMemoryGb(24)
            .passwordHash("n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=")
            .region("us-east-1")
            .tier("production")
            .build());

    }
}

    resources:
  service:
    type: clickhouse:Service
    properties:
      cloudProvider: aws
      idleScaling: true
      idleTimeoutMinutes: 5
      ipAccesses:
        - description: Test IP
          source: 192.168.2.63
      maxTotalMemoryGb: 360
      minTotalMemoryGb: 24
      passwordHash: n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=
      # base64 encoded sha256 hash of "test"
      region: us-east-1
      tier: production

    Create Service Resource

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

    Constructor syntax

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

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            ip_accesses: Optional[Sequence[ServiceIpAccessArgs]] = None,
            tier: Optional[str] = None,
            region: Optional[str] = None,
            cloud_provider: Optional[str] = None,
            encryption_key: Optional[str] = None,
            idle_timeout_minutes: Optional[int] = None,
            idle_scaling: Optional[bool] = None,
            max_total_memory_gb: Optional[int] = None,
            min_total_memory_gb: Optional[int] = None,
            name: Optional[str] = None,
            num_replicas: Optional[int] = None,
            password: Optional[str] = None,
            password_hash: Optional[str] = None,
            encryption_assumed_role_identifier: Optional[str] = None,
            double_sha1_password_hash: Optional[str] = None)
    func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: clickhouse:Service
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 ServiceArgs
    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 ServiceArgs
    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 ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    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 serviceResource = new Clickhouse.Service("serviceResource", new()
{
    IpAccesses = new[]
    {
        new Clickhouse.Inputs.ServiceIpAccessArgs
        {
            Source = "string",
            Description = "string",
        },
    },
    Tier = "string",
    Region = "string",
    CloudProvider = "string",
    EncryptionKey = "string",
    IdleTimeoutMinutes = 0,
    IdleScaling = false,
    MaxTotalMemoryGb = 0,
    MinTotalMemoryGb = 0,
    Name = "string",
    NumReplicas = 0,
    Password = "string",
    PasswordHash = "string",
    EncryptionAssumedRoleIdentifier = "string",
    DoubleSha1PasswordHash = "string",
});

    example, err := clickhouse.NewService(ctx, "serviceResource", &clickhouse.ServiceArgs{
	IpAccesses: clickhouse.ServiceIpAccessArray{
		&clickhouse.ServiceIpAccessArgs{
			Source:      pulumi.String("string"),
			Description: pulumi.String("string"),
		},
	},
	Tier:                            pulumi.String("string"),
	Region:                          pulumi.String("string"),
	CloudProvider:                   pulumi.String("string"),
	EncryptionKey:                   pulumi.String("string"),
	IdleTimeoutMinutes:              pulumi.Int(0),
	IdleScaling:                     pulumi.Bool(false),
	MaxTotalMemoryGb:                pulumi.Int(0),
	MinTotalMemoryGb:                pulumi.Int(0),
	Name:                            pulumi.String("string"),
	NumReplicas:                     pulumi.Int(0),
	Password:                        pulumi.String("string"),
	PasswordHash:                    pulumi.String("string"),
	EncryptionAssumedRoleIdentifier: pulumi.String("string"),
	DoubleSha1PasswordHash:          pulumi.String("string"),
})

    var serviceResource = new Service("serviceResource", ServiceArgs.builder()
    .ipAccesses(ServiceIpAccessArgs.builder()
        .source("string")
        .description("string")
        .build())
    .tier("string")
    .region("string")
    .cloudProvider("string")
    .encryptionKey("string")
    .idleTimeoutMinutes(0)
    .idleScaling(false)
    .maxTotalMemoryGb(0)
    .minTotalMemoryGb(0)
    .name("string")
    .numReplicas(0)
    .password("string")
    .passwordHash("string")
    .encryptionAssumedRoleIdentifier("string")
    .doubleSha1PasswordHash("string")
    .build());

    service_resource = clickhouse.Service("serviceResource",
    ip_accesses=[{
        "source": "string",
        "description": "string",
    }],
    tier="string",
    region="string",
    cloud_provider="string",
    encryption_key="string",
    idle_timeout_minutes=0,
    idle_scaling=False,
    max_total_memory_gb=0,
    min_total_memory_gb=0,
    name="string",
    num_replicas=0,
    password="string",
    password_hash="string",
    encryption_assumed_role_identifier="string",
    double_sha1_password_hash="string")

    const serviceResource = new clickhouse.Service("serviceResource", {
    ipAccesses: [{
        source: "string",
        description: "string",
    }],
    tier: "string",
    region: "string",
    cloudProvider: "string",
    encryptionKey: "string",
    idleTimeoutMinutes: 0,
    idleScaling: false,
    maxTotalMemoryGb: 0,
    minTotalMemoryGb: 0,
    name: "string",
    numReplicas: 0,
    password: "string",
    passwordHash: "string",
    encryptionAssumedRoleIdentifier: "string",
    doubleSha1PasswordHash: "string",
});

    type: clickhouse:Service
properties:
    cloudProvider: string
    doubleSha1PasswordHash: string
    encryptionAssumedRoleIdentifier: string
    encryptionKey: string
    idleScaling: false
    idleTimeoutMinutes: 0
    ipAccesses:
        - description: string
          source: string
    maxTotalMemoryGb: 0
    minTotalMemoryGb: 0
    name: string
    numReplicas: 0
    password: string
    passwordHash: string
    region: string
    tier: string

    Service 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 Service resource accepts the following input properties:

    CloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    IpAccesses List<Pulumiverse.Clickhouse.Inputs.ServiceIpAccess>
    List of IP addresses allowed to access the service.
    Region string
    Region within the cloud provider in which the service is deployed in.
    Tier string
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    DoubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    EncryptionAssumedRoleIdentifier string
    Custom role identifier arn
    EncryptionKey string
    Custom encryption key arn
    IdleScaling bool
    When set to true the service is allowed to scale down to zero when idle.
    IdleTimeoutMinutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    MaxTotalMemoryGb int
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    MinTotalMemoryGb int
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    Name string
    User defined identifier for the service.
    NumReplicas int
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    Password string
    Password for the default user. One of either password or password_hash must be specified.
    PasswordHash string
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    CloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    IpAccesses []ServiceIpAccessArgs
    List of IP addresses allowed to access the service.
    Region string
    Region within the cloud provider in which the service is deployed in.
    Tier string
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    DoubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    EncryptionAssumedRoleIdentifier string
    Custom role identifier arn
    EncryptionKey string
    Custom encryption key arn
    IdleScaling bool
    When set to true the service is allowed to scale down to zero when idle.
    IdleTimeoutMinutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    MaxTotalMemoryGb int
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    MinTotalMemoryGb int
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    Name string
    User defined identifier for the service.
    NumReplicas int
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    Password string
    Password for the default user. One of either password or password_hash must be specified.
    PasswordHash string
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    cloudProvider String
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ipAccesses List<ServiceIpAccess>
    List of IP addresses allowed to access the service.
    region String
    Region within the cloud provider in which the service is deployed in.
    tier String
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    doubleSha1PasswordHash String
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    encryptionAssumedRoleIdentifier String
    Custom role identifier arn
    encryptionKey String
    Custom encryption key arn
    idleScaling Boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes Integer
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    maxTotalMemoryGb Integer
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    minTotalMemoryGb Integer
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    name String
    User defined identifier for the service.
    numReplicas Integer
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    password String
    Password for the default user. One of either password or password_hash must be specified.
    passwordHash String
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    cloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ipAccesses ServiceIpAccess[]
    List of IP addresses allowed to access the service.
    region string
    Region within the cloud provider in which the service is deployed in.
    tier string
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    doubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    encryptionAssumedRoleIdentifier string
    Custom role identifier arn
    encryptionKey string
    Custom encryption key arn
    idleScaling boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    maxTotalMemoryGb number
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    minTotalMemoryGb number
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    name string
    User defined identifier for the service.
    numReplicas number
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    password string
    Password for the default user. One of either password or password_hash must be specified.
    passwordHash string
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    cloud_provider str
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ip_accesses Sequence[ServiceIpAccessArgs]
    List of IP addresses allowed to access the service.
    region str
    Region within the cloud provider in which the service is deployed in.
    tier str
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    double_sha1_password_hash str
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    encryption_assumed_role_identifier str
    Custom role identifier arn
    encryption_key str
    Custom encryption key arn
    idle_scaling bool
    When set to true the service is allowed to scale down to zero when idle.
    idle_timeout_minutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    max_total_memory_gb int
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    min_total_memory_gb int
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    name str
    User defined identifier for the service.
    num_replicas int
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    password str
    Password for the default user. One of either password or password_hash must be specified.
    password_hash str
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    cloudProvider String
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    ipAccesses List<Property Map>
    List of IP addresses allowed to access the service.
    region String
    Region within the cloud provider in which the service is deployed in.
    tier String
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    doubleSha1PasswordHash String
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    encryptionAssumedRoleIdentifier String
    Custom role identifier arn
    encryptionKey String
    Custom encryption key arn
    idleScaling Boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes Number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    maxTotalMemoryGb Number
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    minTotalMemoryGb Number
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    name String
    User defined identifier for the service.
    numReplicas Number
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    password String
    Password for the default user. One of either password or password_hash must be specified.
    passwordHash String
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.

    Outputs

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

    Endpoints List<Pulumiverse.Clickhouse.Outputs.ServiceEndpoint>
    List of public endpoints.
    IamRole string
    IAM role used for accessing objects in s3.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateEndpointConfig Pulumiverse.Clickhouse.Outputs.ServicePrivateEndpointConfig
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    Endpoints []ServiceEndpoint
    List of public endpoints.
    IamRole string
    IAM role used for accessing objects in s3.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    endpoints List<ServiceEndpoint>
    List of public endpoints.
    iamRole String
    IAM role used for accessing objects in s3.
    id String
    The provider-assigned unique ID for this managed resource.
    privateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    endpoints ServiceEndpoint[]
    List of public endpoints.
    iamRole string
    IAM role used for accessing objects in s3.
    id string
    The provider-assigned unique ID for this managed resource.
    privateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    endpoints Sequence[ServiceEndpoint]
    List of public endpoints.
    iam_role str
    IAM role used for accessing objects in s3.
    id str
    The provider-assigned unique ID for this managed resource.
    private_endpoint_config ServicePrivateEndpointConfig
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    endpoints List<Property Map>
    List of public endpoints.
    iamRole String
    IAM role used for accessing objects in s3.
    id String
    The provider-assigned unique ID for this managed resource.
    privateEndpointConfig Property Map
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    Look up Existing Service Resource

    Get an existing Service 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?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider: Optional[str] = None,
        double_sha1_password_hash: Optional[str] = None,
        encryption_assumed_role_identifier: Optional[str] = None,
        encryption_key: Optional[str] = None,
        endpoints: Optional[Sequence[ServiceEndpointArgs]] = None,
        iam_role: Optional[str] = None,
        idle_scaling: Optional[bool] = None,
        idle_timeout_minutes: Optional[int] = None,
        ip_accesses: Optional[Sequence[ServiceIpAccessArgs]] = None,
        max_total_memory_gb: Optional[int] = None,
        min_total_memory_gb: Optional[int] = None,
        name: Optional[str] = None,
        num_replicas: Optional[int] = None,
        password: Optional[str] = None,
        password_hash: Optional[str] = None,
        private_endpoint_config: Optional[ServicePrivateEndpointConfigArgs] = None,
        region: Optional[str] = None,
        tier: Optional[str] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState 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:
    CloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    DoubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    EncryptionAssumedRoleIdentifier string
    Custom role identifier arn
    EncryptionKey string
    Custom encryption key arn
    Endpoints List<Pulumiverse.Clickhouse.Inputs.ServiceEndpoint>
    List of public endpoints.
    IamRole string
    IAM role used for accessing objects in s3.
    IdleScaling bool
    When set to true the service is allowed to scale down to zero when idle.
    IdleTimeoutMinutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    IpAccesses List<Pulumiverse.Clickhouse.Inputs.ServiceIpAccess>
    List of IP addresses allowed to access the service.
    MaxTotalMemoryGb int
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    MinTotalMemoryGb int
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    Name string
    User defined identifier for the service.
    NumReplicas int
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    Password string
    Password for the default user. One of either password or password_hash must be specified.
    PasswordHash string
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    PrivateEndpointConfig Pulumiverse.Clickhouse.Inputs.ServicePrivateEndpointConfig
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    Region string
    Region within the cloud provider in which the service is deployed in.
    Tier string
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    CloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    DoubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    EncryptionAssumedRoleIdentifier string
    Custom role identifier arn
    EncryptionKey string
    Custom encryption key arn
    Endpoints []ServiceEndpointArgs
    List of public endpoints.
    IamRole string
    IAM role used for accessing objects in s3.
    IdleScaling bool
    When set to true the service is allowed to scale down to zero when idle.
    IdleTimeoutMinutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    IpAccesses []ServiceIpAccessArgs
    List of IP addresses allowed to access the service.
    MaxTotalMemoryGb int
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    MinTotalMemoryGb int
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    Name string
    User defined identifier for the service.
    NumReplicas int
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    Password string
    Password for the default user. One of either password or password_hash must be specified.
    PasswordHash string
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    PrivateEndpointConfig ServicePrivateEndpointConfigArgs
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    Region string
    Region within the cloud provider in which the service is deployed in.
    Tier string
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    cloudProvider String
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    doubleSha1PasswordHash String
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    encryptionAssumedRoleIdentifier String
    Custom role identifier arn
    encryptionKey String
    Custom encryption key arn
    endpoints List<ServiceEndpoint>
    List of public endpoints.
    iamRole String
    IAM role used for accessing objects in s3.
    idleScaling Boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes Integer
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    ipAccesses List<ServiceIpAccess>
    List of IP addresses allowed to access the service.
    maxTotalMemoryGb Integer
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    minTotalMemoryGb Integer
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    name String
    User defined identifier for the service.
    numReplicas Integer
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    password String
    Password for the default user. One of either password or password_hash must be specified.
    passwordHash String
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    privateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    region String
    Region within the cloud provider in which the service is deployed in.
    tier String
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    cloudProvider string
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    doubleSha1PasswordHash string
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    encryptionAssumedRoleIdentifier string
    Custom role identifier arn
    encryptionKey string
    Custom encryption key arn
    endpoints ServiceEndpoint[]
    List of public endpoints.
    iamRole string
    IAM role used for accessing objects in s3.
    idleScaling boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    ipAccesses ServiceIpAccess[]
    List of IP addresses allowed to access the service.
    maxTotalMemoryGb number
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    minTotalMemoryGb number
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    name string
    User defined identifier for the service.
    numReplicas number
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    password string
    Password for the default user. One of either password or password_hash must be specified.
    passwordHash string
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    privateEndpointConfig ServicePrivateEndpointConfig
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    region string
    Region within the cloud provider in which the service is deployed in.
    tier string
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    cloud_provider str
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    double_sha1_password_hash str
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    encryption_assumed_role_identifier str
    Custom role identifier arn
    encryption_key str
    Custom encryption key arn
    endpoints Sequence[ServiceEndpointArgs]
    List of public endpoints.
    iam_role str
    IAM role used for accessing objects in s3.
    idle_scaling bool
    When set to true the service is allowed to scale down to zero when idle.
    idle_timeout_minutes int
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    ip_accesses Sequence[ServiceIpAccessArgs]
    List of IP addresses allowed to access the service.
    max_total_memory_gb int
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    min_total_memory_gb int
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    name str
    User defined identifier for the service.
    num_replicas int
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    password str
    Password for the default user. One of either password or password_hash must be specified.
    password_hash str
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    private_endpoint_config ServicePrivateEndpointConfigArgs
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    region str
    Region within the cloud provider in which the service is deployed in.
    tier str
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.
    cloudProvider String
    Cloud provider ('aws', 'gcp', or 'azure') in which the service is deployed in.
    doubleSha1PasswordHash String
    Double SHA1 hash of password for connecting with the MySQL protocol. Cannot be specified if password is specified.
    encryptionAssumedRoleIdentifier String
    Custom role identifier arn
    encryptionKey String
    Custom encryption key arn
    endpoints List<Property Map>
    List of public endpoints.
    iamRole String
    IAM role used for accessing objects in s3.
    idleScaling Boolean
    When set to true the service is allowed to scale down to zero when idle.
    idleTimeoutMinutes Number
    Set minimum idling timeout (in minutes). Must be greater than or equal to 5 minutes. Must be set if idle_scaling is enabled
    ipAccesses List<Property Map>
    List of IP addresses allowed to access the service.
    maxTotalMemoryGb Number
    Maximum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than 360 for non paid services or 720 for paid services.
    minTotalMemoryGb Number
    Minimum total memory of all workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than 24.
    name String
    User defined identifier for the service.
    numReplicas Number
    Number of replicas for the service. Available only for 'production' services. Must be between 3 and 20. Contact support to enable this feature.
    password String
    Password for the default user. One of either password or password_hash must be specified.
    passwordHash String
    SHA256 hash of password for the default user. One of either password or password_hash must be specified.
    privateEndpointConfig Property Map
    Service config for private endpoints

    Deprecated: Please use the clickhouse.PrivateEndpoint.getConfig data source instead.

    region String
    Region within the cloud provider in which the service is deployed in.
    tier String
    Tier of the service: 'development', 'production'. Production services scale, Development are fixed size.

    Supporting Types

    ServiceEndpoint, ServiceEndpointArgs

    Host string
    Endpoint host.
    Port int
    Endpoint port.
    Protocol string
    Endpoint protocol: https or nativesecure
    Host string
    Endpoint host.
    Port int
    Endpoint port.
    Protocol string
    Endpoint protocol: https or nativesecure
    host String
    Endpoint host.
    port Integer
    Endpoint port.
    protocol String
    Endpoint protocol: https or nativesecure
    host string
    Endpoint host.
    port number
    Endpoint port.
    protocol string
    Endpoint protocol: https or nativesecure
    host str
    Endpoint host.
    port int
    Endpoint port.
    protocol str
    Endpoint protocol: https or nativesecure
    host String
    Endpoint host.
    port Number
    Endpoint port.
    protocol String
    Endpoint protocol: https or nativesecure

    ServiceIpAccess, ServiceIpAccessArgs

    Source string
    IP address allowed to access the service. In case you want to set the ip_access to anywhere you should set source to 0.0.0.0/0
    Description string
    Description of the IP address.
    Source string
    IP address allowed to access the service. In case you want to set the ip_access to anywhere you should set source to 0.0.0.0/0
    Description string
    Description of the IP address.
    source String
    IP address allowed to access the service. In case you want to set the ip_access to anywhere you should set source to 0.0.0.0/0
    description String
    Description of the IP address.
    source string
    IP address allowed to access the service. In case you want to set the ip_access to anywhere you should set source to 0.0.0.0/0
    description string
    Description of the IP address.
    source str
    IP address allowed to access the service. In case you want to set the ip_access to anywhere you should set source to 0.0.0.0/0
    description str
    Description of the IP address.
    source String
    IP address allowed to access the service. In case you want to set the ip_access to anywhere you should set source to 0.0.0.0/0
    description String
    Description of the IP address.

    ServicePrivateEndpointConfig, ServicePrivateEndpointConfigArgs

    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource
    PrivateDnsHostname string
    Private DNS Hostname of the VPC you created
    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource
    PrivateDnsHostname string
    Private DNS Hostname of the VPC you created
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource
    privateDnsHostname String
    Private DNS Hostname of the VPC you created
    endpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource
    privateDnsHostname string
    Private DNS Hostname of the VPC you created
    endpoint_service_id str
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource
    private_dns_hostname str
    Private DNS Hostname of the VPC you created
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource
    privateDnsHostname String
    Private DNS Hostname of the VPC you created

    Import

    Services can be imported by specifying the UUID.

    $ pulumi import clickhouse:index/service:Service example xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

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

    Package Details

    Repository
    clickhouse pulumiverse/pulumi-clickhouse
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the clickhouse Terraform Provider.
    clickhouse logo
    Clickhouse v1.0.1 published on Thursday, Sep 5, 2024 by pulumiverse
    pulumiverse/pulumi-clickhouse