vkcs 0.9.3, Apr 15 25

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.DbClusterWithShards

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vk-cs/terraform-provider-vkcs

Example Usage

Cluster with shards restored from backup

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.DbClusterWithShards;
import com.pulumi.vkcs.DbClusterWithShardsArgs;
import com.pulumi.vkcs.inputs.DbClusterWithShardsDatastoreArgs;
import com.pulumi.vkcs.inputs.DbClusterWithShardsShardArgs;
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 dbClusterWithShards = new DbClusterWithShards("dbClusterWithShards", DbClusterWithShardsArgs.builder()
            .datastore(DbClusterWithShardsDatastoreArgs.builder()
                .type("clickhouse")
                .version("24.3")
                .build())
            .shards(            
                DbClusterWithShardsShardArgs.builder()
                    .flavorId("9e931469-1490-489e-88af-29a289681c53")
                    .networks(DbClusterWithShardsShardNetworkArgs.builder()
                        .uuid("3ee9b184-3311-4d85-840b-7a9c48e7beac")
                        .build())
                    .shardId("shard0")
                    .size(2)
                    .volumeSize(10)
                    .volumeType("ceph-ssd")
                    .build(),
                DbClusterWithShardsShardArgs.builder()
                    .flavorId("9e931469-1490-489e-88af-29a289681c53")
                    .networks(DbClusterWithShardsShardNetworkArgs.builder()
                        .uuid("3ee9b184-3311-4d85-840b-7a9c48e7beac")
                        .build())
                    .restorePoint(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .shardId("shard1")
                    .size(2)
                    .volumeSize(10)
                    .volumeType("ceph-ssd")
                    .build())
            .build());

    }
}

resources:
  dbClusterWithShards:
    type: vkcs:DbClusterWithShards
    properties:
      datastore:
        type: clickhouse
        version: '24.3'
      shards:
        - flavorId: 9e931469-1490-489e-88af-29a289681c53
          networks:
            - uuid: 3ee9b184-3311-4d85-840b-7a9c48e7beac
          shardId: shard0
          size: 2
          volumeSize: 10
          volumeType: ceph-ssd
        - flavorId: 9e931469-1490-489e-88af-29a289681c53
          networks:
            - uuid: 3ee9b184-3311-4d85-840b-7a9c48e7beac
          restorePoint:
            - backupId: 7c8110f3-6f7f-4dc3-85c2-16feef9ddc2b
          shardId: shard1
          size: 2
          volumeSize: 10
          volumeType: ceph-ssd

Create DbClusterWithShards Resource

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

Constructor syntax

new DbClusterWithShards(name: string, args: DbClusterWithShardsArgs, opts?: CustomResourceOptions);

@overload
def DbClusterWithShards(resource_name: str,
                        args: DbClusterWithShardsArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def DbClusterWithShards(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        datastore: Optional[DbClusterWithShardsDatastoreArgs] = None,
                        shards: Optional[Sequence[DbClusterWithShardsShardArgs]] = None,
                        name: Optional[str] = None,
                        region: Optional[str] = None,
                        db_cluster_with_shards_id: Optional[str] = None,
                        disk_autoexpand: Optional[DbClusterWithShardsDiskAutoexpandArgs] = None,
                        floating_ip_enabled: Optional[bool] = None,
                        keypair: Optional[str] = None,
                        capabilities: Optional[Sequence[DbClusterWithShardsCapabilityArgs]] = None,
                        configuration_id: Optional[str] = None,
                        restore_point: Optional[DbClusterWithShardsRestorePointArgs] = None,
                        root_enabled: Optional[bool] = None,
                        root_password: Optional[str] = None,
                        cloud_monitoring_enabled: Optional[bool] = None,
                        timeouts: Optional[DbClusterWithShardsTimeoutsArgs] = None,
                        vendor_options: Optional[DbClusterWithShardsVendorOptionsArgs] = None,
                        wal_disk_autoexpand: Optional[DbClusterWithShardsWalDiskAutoexpandArgs] = None)

func NewDbClusterWithShards(ctx *Context, name string, args DbClusterWithShardsArgs, opts ...ResourceOption) (*DbClusterWithShards, error)

public DbClusterWithShards(string name, DbClusterWithShardsArgs args, CustomResourceOptions? opts = null)

public DbClusterWithShards(String name, DbClusterWithShardsArgs args)
public DbClusterWithShards(String name, DbClusterWithShardsArgs args, CustomResourceOptions options)

type: vkcs:DbClusterWithShards
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 DbClusterWithShardsArgs: 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 DbClusterWithShardsArgs: 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 DbClusterWithShardsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DbClusterWithShardsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DbClusterWithShardsArgs: 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 dbClusterWithShardsResource = new Vkcs.DbClusterWithShards("dbClusterWithShardsResource", new()
{
    Datastore = new Vkcs.Inputs.DbClusterWithShardsDatastoreArgs
    {
        Type = "string",
        Version = "string",
    },
    Shards = new[]
    {
        new Vkcs.Inputs.DbClusterWithShardsShardArgs
        {
            FlavorId = "string",
            ShardId = "string",
            Size = 0,
            VolumeSize = 0,
            VolumeType = "string",
            AvailabilityZone = "string",
            Instances = new[]
            {
                new Vkcs.Inputs.DbClusterWithShardsShardInstanceArgs
                {
                    InstanceId = "string",
                    Ips = new[]
                    {
                        "string",
                    },
                },
            },
            Networks = new[]
            {
                new Vkcs.Inputs.DbClusterWithShardsShardNetworkArgs
                {
                    SecurityGroups = new[]
                    {
                        "string",
                    },
                    SubnetId = "string",
                    Uuid = "string",
                },
            },
            ShrinkOptions = new[]
            {
                "string",
            },
            WalVolumes = new[]
            {
                new Vkcs.Inputs.DbClusterWithShardsShardWalVolumeArgs
                {
                    Size = 0,
                    VolumeType = "string",
                },
            },
        },
    },
    Name = "string",
    Region = "string",
    DbClusterWithShardsId = "string",
    DiskAutoexpand = new Vkcs.Inputs.DbClusterWithShardsDiskAutoexpandArgs
    {
        Autoexpand = false,
        MaxDiskSize = 0,
    },
    FloatingIpEnabled = false,
    Keypair = "string",
    Capabilities = new[]
    {
        new Vkcs.Inputs.DbClusterWithShardsCapabilityArgs
        {
            Name = "string",
            Settings = 
            {
                { "string", "string" },
            },
        },
    },
    ConfigurationId = "string",
    RestorePoint = new Vkcs.Inputs.DbClusterWithShardsRestorePointArgs
    {
        BackupId = "string",
    },
    RootEnabled = false,
    RootPassword = "string",
    CloudMonitoringEnabled = false,
    Timeouts = new Vkcs.Inputs.DbClusterWithShardsTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    VendorOptions = new Vkcs.Inputs.DbClusterWithShardsVendorOptionsArgs
    {
        RestartConfirmed = false,
    },
    WalDiskAutoexpand = new Vkcs.Inputs.DbClusterWithShardsWalDiskAutoexpandArgs
    {
        Autoexpand = false,
        MaxDiskSize = 0,
    },
});

example, err := vkcs.NewDbClusterWithShards(ctx, "dbClusterWithShardsResource", &vkcs.DbClusterWithShardsArgs{
Datastore: &.DbClusterWithShardsDatastoreArgs{
Type: pulumi.String("string"),
Version: pulumi.String("string"),
},
Shards: .DbClusterWithShardsShardArray{
&.DbClusterWithShardsShardArgs{
FlavorId: pulumi.String("string"),
ShardId: pulumi.String("string"),
Size: pulumi.Float64(0),
VolumeSize: pulumi.Float64(0),
VolumeType: pulumi.String("string"),
AvailabilityZone: pulumi.String("string"),
Instances: .DbClusterWithShardsShardInstanceArray{
&.DbClusterWithShardsShardInstanceArgs{
InstanceId: pulumi.String("string"),
Ips: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Networks: .DbClusterWithShardsShardNetworkArray{
&.DbClusterWithShardsShardNetworkArgs{
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
SubnetId: pulumi.String("string"),
Uuid: pulumi.String("string"),
},
},
ShrinkOptions: pulumi.StringArray{
pulumi.String("string"),
},
WalVolumes: .DbClusterWithShardsShardWalVolumeArray{
&.DbClusterWithShardsShardWalVolumeArgs{
Size: pulumi.Float64(0),
VolumeType: pulumi.String("string"),
},
},
},
},
Name: pulumi.String("string"),
Region: pulumi.String("string"),
DbClusterWithShardsId: pulumi.String("string"),
DiskAutoexpand: &.DbClusterWithShardsDiskAutoexpandArgs{
Autoexpand: pulumi.Bool(false),
MaxDiskSize: pulumi.Float64(0),
},
FloatingIpEnabled: pulumi.Bool(false),
Keypair: pulumi.String("string"),
Capabilities: .DbClusterWithShardsCapabilityArray{
&.DbClusterWithShardsCapabilityArgs{
Name: pulumi.String("string"),
Settings: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
ConfigurationId: pulumi.String("string"),
RestorePoint: &.DbClusterWithShardsRestorePointArgs{
BackupId: pulumi.String("string"),
},
RootEnabled: pulumi.Bool(false),
RootPassword: pulumi.String("string"),
CloudMonitoringEnabled: pulumi.Bool(false),
Timeouts: &.DbClusterWithShardsTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
VendorOptions: &.DbClusterWithShardsVendorOptionsArgs{
RestartConfirmed: pulumi.Bool(false),
},
WalDiskAutoexpand: &.DbClusterWithShardsWalDiskAutoexpandArgs{
Autoexpand: pulumi.Bool(false),
MaxDiskSize: pulumi.Float64(0),
},
})

var dbClusterWithShardsResource = new DbClusterWithShards("dbClusterWithShardsResource", DbClusterWithShardsArgs.builder()
    .datastore(DbClusterWithShardsDatastoreArgs.builder()
        .type("string")
        .version("string")
        .build())
    .shards(DbClusterWithShardsShardArgs.builder()
        .flavorId("string")
        .shardId("string")
        .size(0)
        .volumeSize(0)
        .volumeType("string")
        .availabilityZone("string")
        .instances(DbClusterWithShardsShardInstanceArgs.builder()
            .instanceId("string")
            .ips("string")
            .build())
        .networks(DbClusterWithShardsShardNetworkArgs.builder()
            .securityGroups("string")
            .subnetId("string")
            .uuid("string")
            .build())
        .shrinkOptions("string")
        .walVolumes(DbClusterWithShardsShardWalVolumeArgs.builder()
            .size(0)
            .volumeType("string")
            .build())
        .build())
    .name("string")
    .region("string")
    .dbClusterWithShardsId("string")
    .diskAutoexpand(DbClusterWithShardsDiskAutoexpandArgs.builder()
        .autoexpand(false)
        .maxDiskSize(0)
        .build())
    .floatingIpEnabled(false)
    .keypair("string")
    .capabilities(DbClusterWithShardsCapabilityArgs.builder()
        .name("string")
        .settings(Map.of("string", "string"))
        .build())
    .configurationId("string")
    .restorePoint(DbClusterWithShardsRestorePointArgs.builder()
        .backupId("string")
        .build())
    .rootEnabled(false)
    .rootPassword("string")
    .cloudMonitoringEnabled(false)
    .timeouts(DbClusterWithShardsTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .vendorOptions(DbClusterWithShardsVendorOptionsArgs.builder()
        .restartConfirmed(false)
        .build())
    .walDiskAutoexpand(DbClusterWithShardsWalDiskAutoexpandArgs.builder()
        .autoexpand(false)
        .maxDiskSize(0)
        .build())
    .build());

db_cluster_with_shards_resource = vkcs.DbClusterWithShards("dbClusterWithShardsResource",
    datastore={
        "type": "string",
        "version": "string",
    },
    shards=[{
        "flavor_id": "string",
        "shard_id": "string",
        "size": 0,
        "volume_size": 0,
        "volume_type": "string",
        "availability_zone": "string",
        "instances": [{
            "instance_id": "string",
            "ips": ["string"],
        }],
        "networks": [{
            "security_groups": ["string"],
            "subnet_id": "string",
            "uuid": "string",
        }],
        "shrink_options": ["string"],
        "wal_volumes": [{
            "size": 0,
            "volume_type": "string",
        }],
    }],
    name="string",
    region="string",
    db_cluster_with_shards_id="string",
    disk_autoexpand={
        "autoexpand": False,
        "max_disk_size": 0,
    },
    floating_ip_enabled=False,
    keypair="string",
    capabilities=[{
        "name": "string",
        "settings": {
            "string": "string",
        },
    }],
    configuration_id="string",
    restore_point={
        "backup_id": "string",
    },
    root_enabled=False,
    root_password="string",
    cloud_monitoring_enabled=False,
    timeouts={
        "create": "string",
        "delete": "string",
    },
    vendor_options={
        "restart_confirmed": False,
    },
    wal_disk_autoexpand={
        "autoexpand": False,
        "max_disk_size": 0,
    })

const dbClusterWithShardsResource = new vkcs.DbClusterWithShards("dbClusterWithShardsResource", {
    datastore: {
        type: "string",
        version: "string",
    },
    shards: [{
        flavorId: "string",
        shardId: "string",
        size: 0,
        volumeSize: 0,
        volumeType: "string",
        availabilityZone: "string",
        instances: [{
            instanceId: "string",
            ips: ["string"],
        }],
        networks: [{
            securityGroups: ["string"],
            subnetId: "string",
            uuid: "string",
        }],
        shrinkOptions: ["string"],
        walVolumes: [{
            size: 0,
            volumeType: "string",
        }],
    }],
    name: "string",
    region: "string",
    dbClusterWithShardsId: "string",
    diskAutoexpand: {
        autoexpand: false,
        maxDiskSize: 0,
    },
    floatingIpEnabled: false,
    keypair: "string",
    capabilities: [{
        name: "string",
        settings: {
            string: "string",
        },
    }],
    configurationId: "string",
    restorePoint: {
        backupId: "string",
    },
    rootEnabled: false,
    rootPassword: "string",
    cloudMonitoringEnabled: false,
    timeouts: {
        create: "string",
        "delete": "string",
    },
    vendorOptions: {
        restartConfirmed: false,
    },
    walDiskAutoexpand: {
        autoexpand: false,
        maxDiskSize: 0,
    },
});

type: vkcs:DbClusterWithShards
properties:
    capabilities:
        - name: string
          settings:
            string: string
    cloudMonitoringEnabled: false
    configurationId: string
    datastore:
        type: string
        version: string
    dbClusterWithShardsId: string
    diskAutoexpand:
        autoexpand: false
        maxDiskSize: 0
    floatingIpEnabled: false
    keypair: string
    name: string
    region: string
    restorePoint:
        backupId: string
    rootEnabled: false
    rootPassword: string
    shards:
        - availabilityZone: string
          flavorId: string
          instances:
            - instanceId: string
              ips:
                - string
          networks:
            - securityGroups:
                - string
              subnetId: string
              uuid: string
          shardId: string
          shrinkOptions:
            - string
          size: 0
          volumeSize: 0
          volumeType: string
          walVolumes:
            - size: 0
              volumeType: string
    timeouts:
        create: string
        delete: string
    vendorOptions:
        restartConfirmed: false
    walDiskAutoexpand:
        autoexpand: false
        maxDiskSize: 0

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

Datastore DbClusterWithShardsDatastore: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
Shards List<DbClusterWithShardsShard>: required → Object that represents cluster shard. There can be several instances of this object.
Capabilities List<DbClusterWithShardsCapability>: optional → Object that represents capability applied to cluster. There can be several instances of this object.
CloudMonitoringEnabled bool: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
ConfigurationId string: optional string → The id of the configuration attached to cluster.
DbClusterWithShardsId string: string → ID of the resource.
DiskAutoexpand DbClusterWithShardsDiskAutoexpand: optional → Object that represents autoresize properties of the cluster.
FloatingIpEnabled bool: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
Keypair string: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
Name string: required string → The name of the cluster. Changing this creates a new cluster.
Region string: optional string → Region to create resource in.
RestorePoint DbClusterWithShardsRestorePoint: optional → Object that represents backup to restore instance from.New since v0.1.4.
RootEnabled bool: optional boolean → Indicates whether root user is enabled for the cluster.
RootPassword string: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
Timeouts DbClusterWithShardsTimeouts
VendorOptions DbClusterWithShardsVendorOptions: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
WalDiskAutoexpand DbClusterWithShardsWalDiskAutoexpand: optional → Object that represents autoresize properties of wal volume of the cluster.

Datastore DbClusterWithShardsDatastoreArgs: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
Shards []DbClusterWithShardsShardArgs: required → Object that represents cluster shard. There can be several instances of this object.
Capabilities []DbClusterWithShardsCapabilityArgs: optional → Object that represents capability applied to cluster. There can be several instances of this object.
CloudMonitoringEnabled bool: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
ConfigurationId string: optional string → The id of the configuration attached to cluster.
DbClusterWithShardsId string: string → ID of the resource.
DiskAutoexpand DbClusterWithShardsDiskAutoexpandArgs: optional → Object that represents autoresize properties of the cluster.
FloatingIpEnabled bool: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
Keypair string: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
Name string: required string → The name of the cluster. Changing this creates a new cluster.
Region string: optional string → Region to create resource in.
RestorePoint DbClusterWithShardsRestorePointArgs: optional → Object that represents backup to restore instance from.New since v0.1.4.
RootEnabled bool: optional boolean → Indicates whether root user is enabled for the cluster.
RootPassword string: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
Timeouts DbClusterWithShardsTimeoutsArgs
VendorOptions DbClusterWithShardsVendorOptionsArgs: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
WalDiskAutoexpand DbClusterWithShardsWalDiskAutoexpandArgs: optional → Object that represents autoresize properties of wal volume of the cluster.

datastore DbClusterWithShardsDatastore: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
shards List<DbClusterWithShardsShard>: required → Object that represents cluster shard. There can be several instances of this object.
capabilities List<DbClusterWithShardsCapability>: optional → Object that represents capability applied to cluster. There can be several instances of this object.
cloudMonitoringEnabled Boolean: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
configurationId String: optional string → The id of the configuration attached to cluster.
dbClusterWithShardsId String: string → ID of the resource.
diskAutoexpand DbClusterWithShardsDiskAutoexpand: optional → Object that represents autoresize properties of the cluster.
floatingIpEnabled Boolean: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
keypair String: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
name String: required string → The name of the cluster. Changing this creates a new cluster.
region String: optional string → Region to create resource in.
restorePoint DbClusterWithShardsRestorePoint: optional → Object that represents backup to restore instance from.New since v0.1.4.
rootEnabled Boolean: optional boolean → Indicates whether root user is enabled for the cluster.
rootPassword String: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
timeouts DbClusterWithShardsTimeouts
vendorOptions DbClusterWithShardsVendorOptions: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
walDiskAutoexpand DbClusterWithShardsWalDiskAutoexpand: optional → Object that represents autoresize properties of wal volume of the cluster.

datastore DbClusterWithShardsDatastore: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
shards DbClusterWithShardsShard[]: required → Object that represents cluster shard. There can be several instances of this object.
capabilities DbClusterWithShardsCapability[]: optional → Object that represents capability applied to cluster. There can be several instances of this object.
cloudMonitoringEnabled boolean: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
configurationId string: optional string → The id of the configuration attached to cluster.
dbClusterWithShardsId string: string → ID of the resource.
diskAutoexpand DbClusterWithShardsDiskAutoexpand: optional → Object that represents autoresize properties of the cluster.
floatingIpEnabled boolean: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
keypair string: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
name string: required string → The name of the cluster. Changing this creates a new cluster.
region string: optional string → Region to create resource in.
restorePoint DbClusterWithShardsRestorePoint: optional → Object that represents backup to restore instance from.New since v0.1.4.
rootEnabled boolean: optional boolean → Indicates whether root user is enabled for the cluster.
rootPassword string: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
timeouts DbClusterWithShardsTimeouts
vendorOptions DbClusterWithShardsVendorOptions: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
walDiskAutoexpand DbClusterWithShardsWalDiskAutoexpand: optional → Object that represents autoresize properties of wal volume of the cluster.

datastore DbClusterWithShardsDatastoreArgs: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
shards Sequence[DbClusterWithShardsShardArgs]: required → Object that represents cluster shard. There can be several instances of this object.
capabilities Sequence[DbClusterWithShardsCapabilityArgs]: optional → Object that represents capability applied to cluster. There can be several instances of this object.
cloud_monitoring_enabled bool: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
configuration_id str: optional string → The id of the configuration attached to cluster.
db_cluster_with_shards_id str: string → ID of the resource.
disk_autoexpand DbClusterWithShardsDiskAutoexpandArgs: optional → Object that represents autoresize properties of the cluster.
floating_ip_enabled bool: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
keypair str: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
name str: required string → The name of the cluster. Changing this creates a new cluster.
region str: optional string → Region to create resource in.
restore_point DbClusterWithShardsRestorePointArgs: optional → Object that represents backup to restore instance from.New since v0.1.4.
root_enabled bool: optional boolean → Indicates whether root user is enabled for the cluster.
root_password str: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
timeouts DbClusterWithShardsTimeoutsArgs
vendor_options DbClusterWithShardsVendorOptionsArgs: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
wal_disk_autoexpand DbClusterWithShardsWalDiskAutoexpandArgs: optional → Object that represents autoresize properties of wal volume of the cluster.

datastore Property Map: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
shards List<Property Map>: required → Object that represents cluster shard. There can be several instances of this object.
capabilities List<Property Map>: optional → Object that represents capability applied to cluster. There can be several instances of this object.
cloudMonitoringEnabled Boolean: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
configurationId String: optional string → The id of the configuration attached to cluster.
dbClusterWithShardsId String: string → ID of the resource.
diskAutoexpand Property Map: optional → Object that represents autoresize properties of the cluster.
floatingIpEnabled Boolean: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
keypair String: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
name String: required string → The name of the cluster. Changing this creates a new cluster.
region String: optional string → Region to create resource in.
restorePoint Property Map: optional → Object that represents backup to restore instance from.New since v0.1.4.
rootEnabled Boolean: optional boolean → Indicates whether root user is enabled for the cluster.
rootPassword String: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
timeouts Property Map
vendorOptions Property Map: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
walDiskAutoexpand Property Map: optional → Object that represents autoresize properties of wal volume of the cluster.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing DbClusterWithShards Resource

Get an existing DbClusterWithShards 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?: DbClusterWithShardsState, opts?: CustomResourceOptions): DbClusterWithShards

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capabilities: Optional[Sequence[DbClusterWithShardsCapabilityArgs]] = None,
        cloud_monitoring_enabled: Optional[bool] = None,
        configuration_id: Optional[str] = None,
        datastore: Optional[DbClusterWithShardsDatastoreArgs] = None,
        db_cluster_with_shards_id: Optional[str] = None,
        disk_autoexpand: Optional[DbClusterWithShardsDiskAutoexpandArgs] = None,
        floating_ip_enabled: Optional[bool] = None,
        keypair: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        restore_point: Optional[DbClusterWithShardsRestorePointArgs] = None,
        root_enabled: Optional[bool] = None,
        root_password: Optional[str] = None,
        shards: Optional[Sequence[DbClusterWithShardsShardArgs]] = None,
        timeouts: Optional[DbClusterWithShardsTimeoutsArgs] = None,
        vendor_options: Optional[DbClusterWithShardsVendorOptionsArgs] = None,
        wal_disk_autoexpand: Optional[DbClusterWithShardsWalDiskAutoexpandArgs] = None) -> DbClusterWithShards

func GetDbClusterWithShards(ctx *Context, name string, id IDInput, state *DbClusterWithShardsState, opts ...ResourceOption) (*DbClusterWithShards, error)

public static DbClusterWithShards Get(string name, Input<string> id, DbClusterWithShardsState? state, CustomResourceOptions? opts = null)

public static DbClusterWithShards get(String name, Output<String> id, DbClusterWithShardsState state, CustomResourceOptions options)

resources:  _:    type: vkcs:DbClusterWithShards    get:      id: ${id}

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:

Capabilities List<DbClusterWithShardsCapability>: optional → Object that represents capability applied to cluster. There can be several instances of this object.
CloudMonitoringEnabled bool: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
ConfigurationId string: optional string → The id of the configuration attached to cluster.
Datastore DbClusterWithShardsDatastore: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
DbClusterWithShardsId string: string → ID of the resource.
DiskAutoexpand DbClusterWithShardsDiskAutoexpand: optional → Object that represents autoresize properties of the cluster.
FloatingIpEnabled bool: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
Keypair string: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
Name string: required string → The name of the cluster. Changing this creates a new cluster.
Region string: optional string → Region to create resource in.
RestorePoint DbClusterWithShardsRestorePoint: optional → Object that represents backup to restore instance from.New since v0.1.4.
RootEnabled bool: optional boolean → Indicates whether root user is enabled for the cluster.
RootPassword string: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
Shards List<DbClusterWithShardsShard>: required → Object that represents cluster shard. There can be several instances of this object.
Timeouts DbClusterWithShardsTimeouts
VendorOptions DbClusterWithShardsVendorOptions: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
WalDiskAutoexpand DbClusterWithShardsWalDiskAutoexpand: optional → Object that represents autoresize properties of wal volume of the cluster.

Capabilities []DbClusterWithShardsCapabilityArgs: optional → Object that represents capability applied to cluster. There can be several instances of this object.
CloudMonitoringEnabled bool: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
ConfigurationId string: optional string → The id of the configuration attached to cluster.
Datastore DbClusterWithShardsDatastoreArgs: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
DbClusterWithShardsId string: string → ID of the resource.
DiskAutoexpand DbClusterWithShardsDiskAutoexpandArgs: optional → Object that represents autoresize properties of the cluster.
FloatingIpEnabled bool: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
Keypair string: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
Name string: required string → The name of the cluster. Changing this creates a new cluster.
Region string: optional string → Region to create resource in.
RestorePoint DbClusterWithShardsRestorePointArgs: optional → Object that represents backup to restore instance from.New since v0.1.4.
RootEnabled bool: optional boolean → Indicates whether root user is enabled for the cluster.
RootPassword string: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
Shards []DbClusterWithShardsShardArgs: required → Object that represents cluster shard. There can be several instances of this object.
Timeouts DbClusterWithShardsTimeoutsArgs
VendorOptions DbClusterWithShardsVendorOptionsArgs: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
WalDiskAutoexpand DbClusterWithShardsWalDiskAutoexpandArgs: optional → Object that represents autoresize properties of wal volume of the cluster.

capabilities List<DbClusterWithShardsCapability>: optional → Object that represents capability applied to cluster. There can be several instances of this object.
cloudMonitoringEnabled Boolean: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
configurationId String: optional string → The id of the configuration attached to cluster.
datastore DbClusterWithShardsDatastore: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
dbClusterWithShardsId String: string → ID of the resource.
diskAutoexpand DbClusterWithShardsDiskAutoexpand: optional → Object that represents autoresize properties of the cluster.
floatingIpEnabled Boolean: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
keypair String: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
name String: required string → The name of the cluster. Changing this creates a new cluster.
region String: optional string → Region to create resource in.
restorePoint DbClusterWithShardsRestorePoint: optional → Object that represents backup to restore instance from.New since v0.1.4.
rootEnabled Boolean: optional boolean → Indicates whether root user is enabled for the cluster.
rootPassword String: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
shards List<DbClusterWithShardsShard>: required → Object that represents cluster shard. There can be several instances of this object.
timeouts DbClusterWithShardsTimeouts
vendorOptions DbClusterWithShardsVendorOptions: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
walDiskAutoexpand DbClusterWithShardsWalDiskAutoexpand: optional → Object that represents autoresize properties of wal volume of the cluster.

capabilities DbClusterWithShardsCapability[]: optional → Object that represents capability applied to cluster. There can be several instances of this object.
cloudMonitoringEnabled boolean: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
configurationId string: optional string → The id of the configuration attached to cluster.
datastore DbClusterWithShardsDatastore: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
dbClusterWithShardsId string: string → ID of the resource.
diskAutoexpand DbClusterWithShardsDiskAutoexpand: optional → Object that represents autoresize properties of the cluster.
floatingIpEnabled boolean: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
keypair string: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
name string: required string → The name of the cluster. Changing this creates a new cluster.
region string: optional string → Region to create resource in.
restorePoint DbClusterWithShardsRestorePoint: optional → Object that represents backup to restore instance from.New since v0.1.4.
rootEnabled boolean: optional boolean → Indicates whether root user is enabled for the cluster.
rootPassword string: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
shards DbClusterWithShardsShard[]: required → Object that represents cluster shard. There can be several instances of this object.
timeouts DbClusterWithShardsTimeouts
vendorOptions DbClusterWithShardsVendorOptions: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
walDiskAutoexpand DbClusterWithShardsWalDiskAutoexpand: optional → Object that represents autoresize properties of wal volume of the cluster.

capabilities Sequence[DbClusterWithShardsCapabilityArgs]: optional → Object that represents capability applied to cluster. There can be several instances of this object.
cloud_monitoring_enabled bool: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
configuration_id str: optional string → The id of the configuration attached to cluster.
datastore DbClusterWithShardsDatastoreArgs: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
db_cluster_with_shards_id str: string → ID of the resource.
disk_autoexpand DbClusterWithShardsDiskAutoexpandArgs: optional → Object that represents autoresize properties of the cluster.
floating_ip_enabled bool: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
keypair str: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
name str: required string → The name of the cluster. Changing this creates a new cluster.
region str: optional string → Region to create resource in.
restore_point DbClusterWithShardsRestorePointArgs: optional → Object that represents backup to restore instance from.New since v0.1.4.
root_enabled bool: optional boolean → Indicates whether root user is enabled for the cluster.
root_password str: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
shards Sequence[DbClusterWithShardsShardArgs]: required → Object that represents cluster shard. There can be several instances of this object.
timeouts DbClusterWithShardsTimeoutsArgs
vendor_options DbClusterWithShardsVendorOptionsArgs: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
wal_disk_autoexpand DbClusterWithShardsWalDiskAutoexpandArgs: optional → Object that represents autoresize properties of wal volume of the cluster.

capabilities List<Property Map>: optional → Object that represents capability applied to cluster. There can be several instances of this object.
cloudMonitoringEnabled Boolean: optional boolean → Enable cloud monitoring for the cluster. Changing this for Redis or MongoDB creates a new instance.New since v0.2.0.
configurationId String: optional string → The id of the configuration attached to cluster.
datastore Property Map: required → Object that represents datastore of the cluster. Changing this creates a new cluster.
dbClusterWithShardsId String: string → ID of the resource.
diskAutoexpand Property Map: optional → Object that represents autoresize properties of the cluster.
floatingIpEnabled Boolean: optional boolean → Boolean field that indicates whether floating ip is created for cluster. Changing this creates a new cluster.
keypair String: optional string → Name of the keypair to be attached to cluster. Changing this creates a new cluster.
name String: required string → The name of the cluster. Changing this creates a new cluster.
region String: optional string → Region to create resource in.
restorePoint Property Map: optional → Object that represents backup to restore instance from.New since v0.1.4.
rootEnabled Boolean: optional boolean → Indicates whether root user is enabled for the cluster.
rootPassword String: optional sensitive string → Password for the root user of the cluster. When enabling root, password is autogenerated, use this field to obtain it.
shards List<Property Map>: required → Object that represents cluster shard. There can be several instances of this object.
timeouts Property Map
vendorOptions Property Map: optional → Map of additional vendor-specific options. Supported options are described below.New since v0.4.0.
walDiskAutoexpand Property Map: optional → Object that represents autoresize properties of wal volume of the cluster.

Supporting Types

DbClusterWithShardsCapability, DbClusterWithShardsCapabilityArgs

Name string: required string → The name of the capability to apply.
Settings Dictionary<string, string>: optional map of string → Map of key-value settings of the capability.

Name string: required string → The name of the capability to apply.
Settings map[string]string: optional map of string → Map of key-value settings of the capability.

name String: required string → The name of the capability to apply.
settings Map<String,String>: optional map of string → Map of key-value settings of the capability.

name string: required string → The name of the capability to apply.
settings {[key: string]: string}: optional map of string → Map of key-value settings of the capability.

name str: required string → The name of the capability to apply.
settings Mapping[str, str]: optional map of string → Map of key-value settings of the capability.

name String: required string → The name of the capability to apply.
settings Map<String>: optional map of string → Map of key-value settings of the capability.

DbClusterWithShardsDatastore, DbClusterWithShardsDatastoreArgs

Type string: required string → Type of the datastore. Changing this creates a new cluster. Must be one of: clickhouse
Version string: required string → Version of the datastore. Changing this creates a new cluster.

Type string: required string → Type of the datastore. Changing this creates a new cluster. Must be one of: clickhouse
Version string: required string → Version of the datastore. Changing this creates a new cluster.

type String: required string → Type of the datastore. Changing this creates a new cluster. Must be one of: clickhouse
version String: required string → Version of the datastore. Changing this creates a new cluster.

type string: required string → Type of the datastore. Changing this creates a new cluster. Must be one of: clickhouse
version string: required string → Version of the datastore. Changing this creates a new cluster.

type str: required string → Type of the datastore. Changing this creates a new cluster. Must be one of: clickhouse
version str: required string → Version of the datastore. Changing this creates a new cluster.

type String: required string → Type of the datastore. Changing this creates a new cluster. Must be one of: clickhouse
version String: required string → Version of the datastore. Changing this creates a new cluster.

DbClusterWithShardsDiskAutoexpand, DbClusterWithShardsDiskAutoexpandArgs

Autoexpand bool: optional boolean → Indicates whether autoresize is enabled.
MaxDiskSize double: optional number → Maximum disk size for autoresize.

Autoexpand bool: optional boolean → Indicates whether autoresize is enabled.
MaxDiskSize float64: optional number → Maximum disk size for autoresize.

autoexpand Boolean: optional boolean → Indicates whether autoresize is enabled.
maxDiskSize Double: optional number → Maximum disk size for autoresize.

autoexpand boolean: optional boolean → Indicates whether autoresize is enabled.
maxDiskSize number: optional number → Maximum disk size for autoresize.

autoexpand bool: optional boolean → Indicates whether autoresize is enabled.
max_disk_size float: optional number → Maximum disk size for autoresize.

autoexpand Boolean: optional boolean → Indicates whether autoresize is enabled.
maxDiskSize Number: optional number → Maximum disk size for autoresize.

DbClusterWithShardsRestorePoint, DbClusterWithShardsRestorePointArgs

BackupId string: required string → ID of the backup.

BackupId string: required string → ID of the backup.

backupId String: required string → ID of the backup.

backupId string: required string → ID of the backup.

backup_id str: required string → ID of the backup.

backupId String: required string → ID of the backup.

DbClusterWithShardsShard, DbClusterWithShardsShardArgs

FlavorId string: required string → The ID of flavor for the cluster shard.
ShardId string: required string → The ID of the shard. Changing this creates a new cluster.
Size double: required number → The number of instances in the cluster shard.
VolumeSize double: required number → Size of the cluster shard instance volume.
VolumeType string: required string → The type of the cluster shard instance volume.
AvailabilityZone string: optional string → The name of the availability zone of the cluster shard. Changing this creates a new cluster.
Instances List<DbClusterWithShardsShardInstance>: object → Shard instances info.New since v0.1.15.
Networks List<DbClusterWithShardsShardNetwork>: optional
ShrinkOptions List<string>: optional string → Used only for shrinking cluster. List of IDs of instances that should remain after shrink. If no options are supplied, shrink operation will choose first non-leader instance to delete.
WalVolumes List<DbClusterWithShardsShardWalVolume>: optional → Object that represents wal volume of the cluster.

FlavorId string: required string → The ID of flavor for the cluster shard.
ShardId string: required string → The ID of the shard. Changing this creates a new cluster.
Size float64: required number → The number of instances in the cluster shard.
VolumeSize float64: required number → Size of the cluster shard instance volume.
VolumeType string: required string → The type of the cluster shard instance volume.
AvailabilityZone string: optional string → The name of the availability zone of the cluster shard. Changing this creates a new cluster.
Instances []DbClusterWithShardsShardInstance: object → Shard instances info.New since v0.1.15.
Networks []DbClusterWithShardsShardNetwork: optional
ShrinkOptions []string: optional string → Used only for shrinking cluster. List of IDs of instances that should remain after shrink. If no options are supplied, shrink operation will choose first non-leader instance to delete.
WalVolumes []DbClusterWithShardsShardWalVolume: optional → Object that represents wal volume of the cluster.

flavorId String: required string → The ID of flavor for the cluster shard.
shardId String: required string → The ID of the shard. Changing this creates a new cluster.
size Double: required number → The number of instances in the cluster shard.
volumeSize Double: required number → Size of the cluster shard instance volume.
volumeType String: required string → The type of the cluster shard instance volume.
availabilityZone String: optional string → The name of the availability zone of the cluster shard. Changing this creates a new cluster.
instances List<DbClusterWithShardsShardInstance>: object → Shard instances info.New since v0.1.15.
networks List<DbClusterWithShardsShardNetwork>: optional
shrinkOptions List<String>: optional string → Used only for shrinking cluster. List of IDs of instances that should remain after shrink. If no options are supplied, shrink operation will choose first non-leader instance to delete.
walVolumes List<DbClusterWithShardsShardWalVolume>: optional → Object that represents wal volume of the cluster.

flavorId string: required string → The ID of flavor for the cluster shard.
shardId string: required string → The ID of the shard. Changing this creates a new cluster.
size number: required number → The number of instances in the cluster shard.
volumeSize number: required number → Size of the cluster shard instance volume.
volumeType string: required string → The type of the cluster shard instance volume.
availabilityZone string: optional string → The name of the availability zone of the cluster shard. Changing this creates a new cluster.
instances DbClusterWithShardsShardInstance[]: object → Shard instances info.New since v0.1.15.
networks DbClusterWithShardsShardNetwork[]: optional
shrinkOptions string[]: optional string → Used only for shrinking cluster. List of IDs of instances that should remain after shrink. If no options are supplied, shrink operation will choose first non-leader instance to delete.
walVolumes DbClusterWithShardsShardWalVolume[]: optional → Object that represents wal volume of the cluster.

flavor_id str: required string → The ID of flavor for the cluster shard.
shard_id str: required string → The ID of the shard. Changing this creates a new cluster.
size float: required number → The number of instances in the cluster shard.
volume_size float: required number → Size of the cluster shard instance volume.
volume_type str: required string → The type of the cluster shard instance volume.
availability_zone str: optional string → The name of the availability zone of the cluster shard. Changing this creates a new cluster.
instances Sequence[DbClusterWithShardsShardInstance]: object → Shard instances info.New since v0.1.15.
networks Sequence[DbClusterWithShardsShardNetwork]: optional
shrink_options Sequence[str]: optional string → Used only for shrinking cluster. List of IDs of instances that should remain after shrink. If no options are supplied, shrink operation will choose first non-leader instance to delete.
wal_volumes Sequence[DbClusterWithShardsShardWalVolume]: optional → Object that represents wal volume of the cluster.

flavorId String: required string → The ID of flavor for the cluster shard.
shardId String: required string → The ID of the shard. Changing this creates a new cluster.
size Number: required number → The number of instances in the cluster shard.
volumeSize Number: required number → Size of the cluster shard instance volume.
volumeType String: required string → The type of the cluster shard instance volume.
availabilityZone String: optional string → The name of the availability zone of the cluster shard. Changing this creates a new cluster.
instances List<Property Map>: object → Shard instances info.New since v0.1.15.
networks List<Property Map>: optional
shrinkOptions List<String>: optional string → Used only for shrinking cluster. List of IDs of instances that should remain after shrink. If no options are supplied, shrink operation will choose first non-leader instance to delete.
walVolumes List<Property Map>: optional → Object that represents wal volume of the cluster.

DbClusterWithShardsShardInstance, DbClusterWithShardsShardInstanceArgs

InstanceId string
Ips List<string>

InstanceId string
Ips []string

instanceId String
ips List<String>

instanceId string
ips string[]

instance_id str
ips Sequence[str]

instanceId String
ips List<String>

DbClusterWithShardsShardNetwork, DbClusterWithShardsShardNetworkArgs

Port string: optional deprecated string → The port id of the network. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.
Deprecated: Deprecated
SecurityGroups List<string>: optional set of string → An array of one or more security group IDs to associate with the shard instances. Changing this creates a new cluster.New since v0.2.0.
SubnetId string: optional string → The id of the subnet. Changing this creates a new cluster.New since v0.1.15.
Uuid string: optional string → The id of the network. Changing this creates a new cluster. Note: Although this argument is marked as optional, it is actually required at the moment. Not setting a value for it may cause an error.

Port string: optional deprecated string → The port id of the network. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.
Deprecated: Deprecated
SecurityGroups []string: optional set of string → An array of one or more security group IDs to associate with the shard instances. Changing this creates a new cluster.New since v0.2.0.
SubnetId string: optional string → The id of the subnet. Changing this creates a new cluster.New since v0.1.15.
Uuid string: optional string → The id of the network. Changing this creates a new cluster. Note: Although this argument is marked as optional, it is actually required at the moment. Not setting a value for it may cause an error.

port String: optional deprecated string → The port id of the network. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.
Deprecated: Deprecated
securityGroups List<String>: optional set of string → An array of one or more security group IDs to associate with the shard instances. Changing this creates a new cluster.New since v0.2.0.
subnetId String: optional string → The id of the subnet. Changing this creates a new cluster.New since v0.1.15.
uuid String: optional string → The id of the network. Changing this creates a new cluster. Note: Although this argument is marked as optional, it is actually required at the moment. Not setting a value for it may cause an error.

port string: optional deprecated string → The port id of the network. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.
Deprecated: Deprecated
securityGroups string[]: optional set of string → An array of one or more security group IDs to associate with the shard instances. Changing this creates a new cluster.New since v0.2.0.
subnetId string: optional string → The id of the subnet. Changing this creates a new cluster.New since v0.1.15.
uuid string: optional string → The id of the network. Changing this creates a new cluster. Note: Although this argument is marked as optional, it is actually required at the moment. Not setting a value for it may cause an error.

port str: optional deprecated string → The port id of the network. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.
Deprecated: Deprecated
security_groups Sequence[str]: optional set of string → An array of one or more security group IDs to associate with the shard instances. Changing this creates a new cluster.New since v0.2.0.
subnet_id str: optional string → The id of the subnet. Changing this creates a new cluster.New since v0.1.15.
uuid str: optional string → The id of the network. Changing this creates a new cluster. Note: Although this argument is marked as optional, it is actually required at the moment. Not setting a value for it may cause an error.

port String: optional deprecated string → The port id of the network. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.
Deprecated: Deprecated
securityGroups List<String>: optional set of string → An array of one or more security group IDs to associate with the shard instances. Changing this creates a new cluster.New since v0.2.0.
subnetId String: optional string → The id of the subnet. Changing this creates a new cluster.New since v0.1.15.
uuid String: optional string → The id of the network. Changing this creates a new cluster. Note: Although this argument is marked as optional, it is actually required at the moment. Not setting a value for it may cause an error.

DbClusterWithShardsShardWalVolume, DbClusterWithShardsShardWalVolumeArgs

Size double: required number → Size of the instance wal volume.
VolumeType string: required string → The type of the cluster wal volume.

Size float64: required number → Size of the instance wal volume.
VolumeType string: required string → The type of the cluster wal volume.

size Double: required number → Size of the instance wal volume.
volumeType String: required string → The type of the cluster wal volume.

size number: required number → Size of the instance wal volume.
volumeType string: required string → The type of the cluster wal volume.

size float: required number → Size of the instance wal volume.
volume_type str: required string → The type of the cluster wal volume.

size Number: required number → Size of the instance wal volume.
volumeType String: required string → The type of the cluster wal volume.

DbClusterWithShardsTimeouts, DbClusterWithShardsTimeoutsArgs

Create string
Delete string

Create string
Delete string

create String
delete String

create string
delete string

create str
delete str

create String
delete String

DbClusterWithShardsVendorOptions, DbClusterWithShardsVendorOptionsArgs

RestartConfirmed bool: optional boolean → Boolean to confirm autorestart of the cluster's instances if it is required to apply configuration group changes.

RestartConfirmed bool: optional boolean → Boolean to confirm autorestart of the cluster's instances if it is required to apply configuration group changes.

restartConfirmed Boolean: optional boolean → Boolean to confirm autorestart of the cluster's instances if it is required to apply configuration group changes.

restartConfirmed boolean: optional boolean → Boolean to confirm autorestart of the cluster's instances if it is required to apply configuration group changes.

restart_confirmed bool: optional boolean → Boolean to confirm autorestart of the cluster's instances if it is required to apply configuration group changes.

restartConfirmed Boolean: optional boolean → Boolean to confirm autorestart of the cluster's instances if it is required to apply configuration group changes.

DbClusterWithShardsWalDiskAutoexpand, DbClusterWithShardsWalDiskAutoexpandArgs

Autoexpand bool: optional boolean → Indicates whether wal volume autoresize is enabled.
MaxDiskSize double: optional number → Maximum disk size for wal volume autoresize.

Autoexpand bool: optional boolean → Indicates whether wal volume autoresize is enabled.
MaxDiskSize float64: optional number → Maximum disk size for wal volume autoresize.

autoexpand Boolean: optional boolean → Indicates whether wal volume autoresize is enabled.
maxDiskSize Double: optional number → Maximum disk size for wal volume autoresize.

autoexpand boolean: optional boolean → Indicates whether wal volume autoresize is enabled.
maxDiskSize number: optional number → Maximum disk size for wal volume autoresize.

autoexpand bool: optional boolean → Indicates whether wal volume autoresize is enabled.
max_disk_size float: optional number → Maximum disk size for wal volume autoresize.

autoexpand Boolean: optional boolean → Indicates whether wal volume autoresize is enabled.
maxDiskSize Number: optional number → Maximum disk size for wal volume autoresize.

Import

Clusters can be imported using the id, e.g.

$ pulumi import vkcs:index/dbClusterWithShards:DbClusterWithShards mycluster 708a74a1-6b00-4a96-938c-28a8a6d98590

After the import you can use terraform show to view imported fields and write their values to your .tf file.

You should at least add following fields to your .tf file:

name, datastore, and for each shard add: shard_id, size, flavor_id, volume_size, volume_type

Please, use "IMPORTED" as value for volume_type field.

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

Package Details

Repository: vkcs vk-cs/terraform-provider-vkcs
License
Notes: This Pulumi package is based on the vkcs Terraform Provider.

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vk-cs/terraform-provider-vkcs

vkcs.DbClusterWithShards

On this page

On this page

Example Usage

Cluster with shards restored from backup

Create DbClusterWithShards Resource

Constructor syntax

Parameters

Constructor example

DbClusterWithShards Resource Properties

Inputs

Outputs

Look up Existing DbClusterWithShards Resource

Supporting Types

DbClusterWithShardsCapability, DbClusterWithShardsCapabilityArgs

DbClusterWithShardsDatastore, DbClusterWithShardsDatastoreArgs

DbClusterWithShardsDiskAutoexpand, DbClusterWithShardsDiskAutoexpandArgs

DbClusterWithShardsRestorePoint, DbClusterWithShardsRestorePointArgs

DbClusterWithShardsShard, DbClusterWithShardsShardArgs

DbClusterWithShardsShardInstance, DbClusterWithShardsShardInstanceArgs

DbClusterWithShardsShardNetwork, DbClusterWithShardsShardNetworkArgs

DbClusterWithShardsShardWalVolume, DbClusterWithShardsShardWalVolumeArgs

DbClusterWithShardsTimeouts, DbClusterWithShardsTimeoutsArgs

DbClusterWithShardsVendorOptions, DbClusterWithShardsVendorOptionsArgs

DbClusterWithShardsWalDiskAutoexpand, DbClusterWithShardsWalDiskAutoexpandArgs

Import

Package Details

On this page

On this page