Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. CbsStorage
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.CbsStorage

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create a CBS storage.

    NOTE: When creating an encrypted disk, if kms_key_id is not entered, the product side will generate a key by default.

    NOTE: When using CBS encrypted disk, it is necessary to add CVM_QcsRole role and QcloudKMSAccessForCVMRole strategy to the account.

    Example Usage

    Create a standard CBS storage

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

const example = new tencentcloud.CbsStorage("example", {
    availabilityZone: "ap-guangzhou-3",
    encrypt: false,
    projectId: 0,
    storageName: "tf-example",
    storageSize: 100,
    storageType: "CLOUD_SSD",
    tags: {
        createBy: "Terraform",
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.CbsStorage("example",
    availability_zone="ap-guangzhou-3",
    encrypt=False,
    project_id=0,
    storage_name="tf-example",
    storage_size=100,
    storage_type="CLOUD_SSD",
    tags={
        "createBy": "Terraform",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewCbsStorage(ctx, "example", &tencentcloud.CbsStorageArgs{
			AvailabilityZone: pulumi.String("ap-guangzhou-3"),
			Encrypt:          pulumi.Bool(false),
			ProjectId:        pulumi.Float64(0),
			StorageName:      pulumi.String("tf-example"),
			StorageSize:      pulumi.Float64(100),
			StorageType:      pulumi.String("CLOUD_SSD"),
			Tags: pulumi.StringMap{
				"createBy": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.CbsStorage("example", new()
    {
        AvailabilityZone = "ap-guangzhou-3",
        Encrypt = false,
        ProjectId = 0,
        StorageName = "tf-example",
        StorageSize = 100,
        StorageType = "CLOUD_SSD",
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.CbsStorage;
import com.pulumi.tencentcloud.CbsStorageArgs;
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 example = new CbsStorage("example", CbsStorageArgs.builder()
            .availabilityZone("ap-guangzhou-3")
            .encrypt(false)
            .projectId(0)
            .storageName("tf-example")
            .storageSize(100)
            .storageType("CLOUD_SSD")
            .tags(Map.of("createBy", "Terraform"))
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:CbsStorage
    properties:
      availabilityZone: ap-guangzhou-3
      encrypt: false
      projectId: 0
      storageName: tf-example
      storageSize: 100
      storageType: CLOUD_SSD
      tags:
        createBy: Terraform

    Create an encrypted CBS storage with customize kms_key_id

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

const example = new tencentcloud.CbsStorage("example", {
    availabilityZone: "ap-guangzhou-3",
    encrypt: true,
    kmsKeyId: "2e860789-7ef0-11ef-8d1c-5254001955d1",
    projectId: 0,
    storageName: "tf-example",
    storageSize: 100,
    storageType: "CLOUD_SSD",
    tags: {
        createBy: "Terraform",
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.CbsStorage("example",
    availability_zone="ap-guangzhou-3",
    encrypt=True,
    kms_key_id="2e860789-7ef0-11ef-8d1c-5254001955d1",
    project_id=0,
    storage_name="tf-example",
    storage_size=100,
    storage_type="CLOUD_SSD",
    tags={
        "createBy": "Terraform",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewCbsStorage(ctx, "example", &tencentcloud.CbsStorageArgs{
			AvailabilityZone: pulumi.String("ap-guangzhou-3"),
			Encrypt:          pulumi.Bool(true),
			KmsKeyId:         pulumi.String("2e860789-7ef0-11ef-8d1c-5254001955d1"),
			ProjectId:        pulumi.Float64(0),
			StorageName:      pulumi.String("tf-example"),
			StorageSize:      pulumi.Float64(100),
			StorageType:      pulumi.String("CLOUD_SSD"),
			Tags: pulumi.StringMap{
				"createBy": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.CbsStorage("example", new()
    {
        AvailabilityZone = "ap-guangzhou-3",
        Encrypt = true,
        KmsKeyId = "2e860789-7ef0-11ef-8d1c-5254001955d1",
        ProjectId = 0,
        StorageName = "tf-example",
        StorageSize = 100,
        StorageType = "CLOUD_SSD",
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.CbsStorage;
import com.pulumi.tencentcloud.CbsStorageArgs;
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 example = new CbsStorage("example", CbsStorageArgs.builder()
            .availabilityZone("ap-guangzhou-3")
            .encrypt(true)
            .kmsKeyId("2e860789-7ef0-11ef-8d1c-5254001955d1")
            .projectId(0)
            .storageName("tf-example")
            .storageSize(100)
            .storageType("CLOUD_SSD")
            .tags(Map.of("createBy", "Terraform"))
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:CbsStorage
    properties:
      availabilityZone: ap-guangzhou-3
      encrypt: true
      kmsKeyId: 2e860789-7ef0-11ef-8d1c-5254001955d1
      projectId: 0
      storageName: tf-example
      storageSize: 100
      storageType: CLOUD_SSD
      tags:
        createBy: Terraform

    Create an encrypted CBS storage with default generated kms_key_id

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

const example = new tencentcloud.CbsStorage("example", {
    availabilityZone: "ap-guangzhou-3",
    encrypt: true,
    projectId: 0,
    storageName: "tf-example",
    storageSize: 100,
    storageType: "CLOUD_SSD",
    tags: {
        createBy: "Terraform",
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.CbsStorage("example",
    availability_zone="ap-guangzhou-3",
    encrypt=True,
    project_id=0,
    storage_name="tf-example",
    storage_size=100,
    storage_type="CLOUD_SSD",
    tags={
        "createBy": "Terraform",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewCbsStorage(ctx, "example", &tencentcloud.CbsStorageArgs{
			AvailabilityZone: pulumi.String("ap-guangzhou-3"),
			Encrypt:          pulumi.Bool(true),
			ProjectId:        pulumi.Float64(0),
			StorageName:      pulumi.String("tf-example"),
			StorageSize:      pulumi.Float64(100),
			StorageType:      pulumi.String("CLOUD_SSD"),
			Tags: pulumi.StringMap{
				"createBy": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.CbsStorage("example", new()
    {
        AvailabilityZone = "ap-guangzhou-3",
        Encrypt = true,
        ProjectId = 0,
        StorageName = "tf-example",
        StorageSize = 100,
        StorageType = "CLOUD_SSD",
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.CbsStorage;
import com.pulumi.tencentcloud.CbsStorageArgs;
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 example = new CbsStorage("example", CbsStorageArgs.builder()
            .availabilityZone("ap-guangzhou-3")
            .encrypt(true)
            .projectId(0)
            .storageName("tf-example")
            .storageSize(100)
            .storageType("CLOUD_SSD")
            .tags(Map.of("createBy", "Terraform"))
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:CbsStorage
    properties:
      availabilityZone: ap-guangzhou-3
      encrypt: true
      projectId: 0
      storageName: tf-example
      storageSize: 100
      storageType: CLOUD_SSD
      tags:
        createBy: Terraform

    Create a dedicated cluster CBS storage

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

const example = new tencentcloud.CbsStorage("example", {
    availabilityZone: "ap-guangzhou-4",
    chargeType: "DEDICATED_CLUSTER_PAID",
    dedicatedClusterId: "cluster-262n63e8",
    encrypt: false,
    projectId: 0,
    storageName: "tf-example",
    storageSize: 100,
    storageType: "CLOUD_SSD",
    tags: {
        createBy: "Terraform",
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.CbsStorage("example",
    availability_zone="ap-guangzhou-4",
    charge_type="DEDICATED_CLUSTER_PAID",
    dedicated_cluster_id="cluster-262n63e8",
    encrypt=False,
    project_id=0,
    storage_name="tf-example",
    storage_size=100,
    storage_type="CLOUD_SSD",
    tags={
        "createBy": "Terraform",
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewCbsStorage(ctx, "example", &tencentcloud.CbsStorageArgs{
			AvailabilityZone:   pulumi.String("ap-guangzhou-4"),
			ChargeType:         pulumi.String("DEDICATED_CLUSTER_PAID"),
			DedicatedClusterId: pulumi.String("cluster-262n63e8"),
			Encrypt:            pulumi.Bool(false),
			ProjectId:          pulumi.Float64(0),
			StorageName:        pulumi.String("tf-example"),
			StorageSize:        pulumi.Float64(100),
			StorageType:        pulumi.String("CLOUD_SSD"),
			Tags: pulumi.StringMap{
				"createBy": pulumi.String("Terraform"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.CbsStorage("example", new()
    {
        AvailabilityZone = "ap-guangzhou-4",
        ChargeType = "DEDICATED_CLUSTER_PAID",
        DedicatedClusterId = "cluster-262n63e8",
        Encrypt = false,
        ProjectId = 0,
        StorageName = "tf-example",
        StorageSize = 100,
        StorageType = "CLOUD_SSD",
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.CbsStorage;
import com.pulumi.tencentcloud.CbsStorageArgs;
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 example = new CbsStorage("example", CbsStorageArgs.builder()
            .availabilityZone("ap-guangzhou-4")
            .chargeType("DEDICATED_CLUSTER_PAID")
            .dedicatedClusterId("cluster-262n63e8")
            .encrypt(false)
            .projectId(0)
            .storageName("tf-example")
            .storageSize(100)
            .storageType("CLOUD_SSD")
            .tags(Map.of("createBy", "Terraform"))
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:CbsStorage
    properties:
      availabilityZone: ap-guangzhou-4
      chargeType: DEDICATED_CLUSTER_PAID
      dedicatedClusterId: cluster-262n63e8
      encrypt: false
      projectId: 0
      storageName: tf-example
      storageSize: 100
      storageType: CLOUD_SSD
      tags:
        createBy: Terraform

    Create CbsStorage Resource

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

    Constructor syntax

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

@overload
def CbsStorage(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               availability_zone: Optional[str] = None,
               storage_type: Optional[str] = None,
               storage_size: Optional[float] = None,
               storage_name: Optional[str] = None,
               period: Optional[float] = None,
               project_id: Optional[float] = None,
               force_delete: Optional[bool] = None,
               kms_key_id: Optional[str] = None,
               disk_backup_quota: Optional[float] = None,
               prepaid_period: Optional[float] = None,
               prepaid_renew_flag: Optional[str] = None,
               encrypt: Optional[bool] = None,
               snapshot_id: Optional[str] = None,
               dedicated_cluster_id: Optional[str] = None,
               charge_type: Optional[str] = None,
               cbs_storage_id: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               throughput_performance: Optional[float] = None)
    func NewCbsStorage(ctx *Context, name string, args CbsStorageArgs, opts ...ResourceOption) (*CbsStorage, error)
    public CbsStorage(string name, CbsStorageArgs args, CustomResourceOptions? opts = null)
    public CbsStorage(String name, CbsStorageArgs args)
public CbsStorage(String name, CbsStorageArgs args, CustomResourceOptions options)

    type: tencentcloud:CbsStorage
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 CbsStorageArgs
    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 CbsStorageArgs
    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 CbsStorageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CbsStorageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CbsStorageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    AvailabilityZone string
    The available zone that the CBS instance locates at.
    StorageName string
    Name of CBS. The maximum length can not exceed 60 bytes.
    StorageSize double
    Volume of CBS, and unit is GB.
    StorageType string
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    CbsStorageId string
    ID of the resource.
    ChargeType string
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    DedicatedClusterId string
    Exclusive cluster id.
    DiskBackupQuota double
    The quota of backup points of cloud disk.
    Encrypt bool
    Pass in this parameter to create an encrypted cloud disk.
    ForceDelete bool
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    KmsKeyId string
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    Period double
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    PrepaidPeriod double
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    PrepaidRenewFlag string
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    ProjectId double
    ID of the project to which the instance belongs.
    SnapshotId string
    ID of the snapshot. If specified, created the CBS by this snapshot.
    Tags Dictionary<string, string>
    The available tags within this CBS.
    ThroughputPerformance double
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    AvailabilityZone string
    The available zone that the CBS instance locates at.
    StorageName string
    Name of CBS. The maximum length can not exceed 60 bytes.
    StorageSize float64
    Volume of CBS, and unit is GB.
    StorageType string
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    CbsStorageId string
    ID of the resource.
    ChargeType string
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    DedicatedClusterId string
    Exclusive cluster id.
    DiskBackupQuota float64
    The quota of backup points of cloud disk.
    Encrypt bool
    Pass in this parameter to create an encrypted cloud disk.
    ForceDelete bool
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    KmsKeyId string
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    Period float64
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    PrepaidPeriod float64
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    PrepaidRenewFlag string
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    ProjectId float64
    ID of the project to which the instance belongs.
    SnapshotId string
    ID of the snapshot. If specified, created the CBS by this snapshot.
    Tags map[string]string
    The available tags within this CBS.
    ThroughputPerformance float64
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    availabilityZone String
    The available zone that the CBS instance locates at.
    storageName String
    Name of CBS. The maximum length can not exceed 60 bytes.
    storageSize Double
    Volume of CBS, and unit is GB.
    storageType String
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    cbsStorageId String
    ID of the resource.
    chargeType String
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    dedicatedClusterId String
    Exclusive cluster id.
    diskBackupQuota Double
    The quota of backup points of cloud disk.
    encrypt Boolean
    Pass in this parameter to create an encrypted cloud disk.
    forceDelete Boolean
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    kmsKeyId String
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    period Double
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    prepaidPeriod Double
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    prepaidRenewFlag String
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    projectId Double
    ID of the project to which the instance belongs.
    snapshotId String
    ID of the snapshot. If specified, created the CBS by this snapshot.
    tags Map<String,String>
    The available tags within this CBS.
    throughputPerformance Double
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    availabilityZone string
    The available zone that the CBS instance locates at.
    storageName string
    Name of CBS. The maximum length can not exceed 60 bytes.
    storageSize number
    Volume of CBS, and unit is GB.
    storageType string
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    cbsStorageId string
    ID of the resource.
    chargeType string
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    dedicatedClusterId string
    Exclusive cluster id.
    diskBackupQuota number
    The quota of backup points of cloud disk.
    encrypt boolean
    Pass in this parameter to create an encrypted cloud disk.
    forceDelete boolean
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    kmsKeyId string
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    period number
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    prepaidPeriod number
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    prepaidRenewFlag string
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    projectId number
    ID of the project to which the instance belongs.
    snapshotId string
    ID of the snapshot. If specified, created the CBS by this snapshot.
    tags {[key: string]: string}
    The available tags within this CBS.
    throughputPerformance number
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    availability_zone str
    The available zone that the CBS instance locates at.
    storage_name str
    Name of CBS. The maximum length can not exceed 60 bytes.
    storage_size float
    Volume of CBS, and unit is GB.
    storage_type str
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    cbs_storage_id str
    ID of the resource.
    charge_type str
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    dedicated_cluster_id str
    Exclusive cluster id.
    disk_backup_quota float
    The quota of backup points of cloud disk.
    encrypt bool
    Pass in this parameter to create an encrypted cloud disk.
    force_delete bool
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    kms_key_id str
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    period float
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    prepaid_period float
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    prepaid_renew_flag str
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    project_id float
    ID of the project to which the instance belongs.
    snapshot_id str
    ID of the snapshot. If specified, created the CBS by this snapshot.
    tags Mapping[str, str]
    The available tags within this CBS.
    throughput_performance float
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    availabilityZone String
    The available zone that the CBS instance locates at.
    storageName String
    Name of CBS. The maximum length can not exceed 60 bytes.
    storageSize Number
    Volume of CBS, and unit is GB.
    storageType String
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    cbsStorageId String
    ID of the resource.
    chargeType String
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    dedicatedClusterId String
    Exclusive cluster id.
    diskBackupQuota Number
    The quota of backup points of cloud disk.
    encrypt Boolean
    Pass in this parameter to create an encrypted cloud disk.
    forceDelete Boolean
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    kmsKeyId String
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    period Number
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    prepaidPeriod Number
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    prepaidRenewFlag String
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    projectId Number
    ID of the project to which the instance belongs.
    snapshotId String
    ID of the snapshot. If specified, created the CBS by this snapshot.
    tags Map<String>
    The available tags within this CBS.
    throughputPerformance Number
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

    Outputs

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

    Attached bool
    Indicates whether the CBS is mounted the CVM.
    Id string
    The provider-assigned unique ID for this managed resource.
    StorageStatus string
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    Attached bool
    Indicates whether the CBS is mounted the CVM.
    Id string
    The provider-assigned unique ID for this managed resource.
    StorageStatus string
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    attached Boolean
    Indicates whether the CBS is mounted the CVM.
    id String
    The provider-assigned unique ID for this managed resource.
    storageStatus String
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    attached boolean
    Indicates whether the CBS is mounted the CVM.
    id string
    The provider-assigned unique ID for this managed resource.
    storageStatus string
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    attached bool
    Indicates whether the CBS is mounted the CVM.
    id str
    The provider-assigned unique ID for this managed resource.
    storage_status str
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    attached Boolean
    Indicates whether the CBS is mounted the CVM.
    id String
    The provider-assigned unique ID for this managed resource.
    storageStatus String
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.

    Look up Existing CbsStorage Resource

    Get an existing CbsStorage 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?: CbsStorageState, opts?: CustomResourceOptions): CbsStorage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attached: Optional[bool] = None,
        availability_zone: Optional[str] = None,
        cbs_storage_id: Optional[str] = None,
        charge_type: Optional[str] = None,
        dedicated_cluster_id: Optional[str] = None,
        disk_backup_quota: Optional[float] = None,
        encrypt: Optional[bool] = None,
        force_delete: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        period: Optional[float] = None,
        prepaid_period: Optional[float] = None,
        prepaid_renew_flag: Optional[str] = None,
        project_id: Optional[float] = None,
        snapshot_id: Optional[str] = None,
        storage_name: Optional[str] = None,
        storage_size: Optional[float] = None,
        storage_status: Optional[str] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        throughput_performance: Optional[float] = None) -> CbsStorage
    func GetCbsStorage(ctx *Context, name string, id IDInput, state *CbsStorageState, opts ...ResourceOption) (*CbsStorage, error)
    public static CbsStorage Get(string name, Input<string> id, CbsStorageState? state, CustomResourceOptions? opts = null)
    public static CbsStorage get(String name, Output<String> id, CbsStorageState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:CbsStorage    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:
    Attached bool
    Indicates whether the CBS is mounted the CVM.
    AvailabilityZone string
    The available zone that the CBS instance locates at.
    CbsStorageId string
    ID of the resource.
    ChargeType string
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    DedicatedClusterId string
    Exclusive cluster id.
    DiskBackupQuota double
    The quota of backup points of cloud disk.
    Encrypt bool
    Pass in this parameter to create an encrypted cloud disk.
    ForceDelete bool
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    KmsKeyId string
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    Period double
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    PrepaidPeriod double
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    PrepaidRenewFlag string
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    ProjectId double
    ID of the project to which the instance belongs.
    SnapshotId string
    ID of the snapshot. If specified, created the CBS by this snapshot.
    StorageName string
    Name of CBS. The maximum length can not exceed 60 bytes.
    StorageSize double
    Volume of CBS, and unit is GB.
    StorageStatus string
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    StorageType string
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    Tags Dictionary<string, string>
    The available tags within this CBS.
    ThroughputPerformance double
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    Attached bool
    Indicates whether the CBS is mounted the CVM.
    AvailabilityZone string
    The available zone that the CBS instance locates at.
    CbsStorageId string
    ID of the resource.
    ChargeType string
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    DedicatedClusterId string
    Exclusive cluster id.
    DiskBackupQuota float64
    The quota of backup points of cloud disk.
    Encrypt bool
    Pass in this parameter to create an encrypted cloud disk.
    ForceDelete bool
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    KmsKeyId string
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    Period float64
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    PrepaidPeriod float64
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    PrepaidRenewFlag string
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    ProjectId float64
    ID of the project to which the instance belongs.
    SnapshotId string
    ID of the snapshot. If specified, created the CBS by this snapshot.
    StorageName string
    Name of CBS. The maximum length can not exceed 60 bytes.
    StorageSize float64
    Volume of CBS, and unit is GB.
    StorageStatus string
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    StorageType string
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    Tags map[string]string
    The available tags within this CBS.
    ThroughputPerformance float64
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    attached Boolean
    Indicates whether the CBS is mounted the CVM.
    availabilityZone String
    The available zone that the CBS instance locates at.
    cbsStorageId String
    ID of the resource.
    chargeType String
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    dedicatedClusterId String
    Exclusive cluster id.
    diskBackupQuota Double
    The quota of backup points of cloud disk.
    encrypt Boolean
    Pass in this parameter to create an encrypted cloud disk.
    forceDelete Boolean
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    kmsKeyId String
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    period Double
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    prepaidPeriod Double
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    prepaidRenewFlag String
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    projectId Double
    ID of the project to which the instance belongs.
    snapshotId String
    ID of the snapshot. If specified, created the CBS by this snapshot.
    storageName String
    Name of CBS. The maximum length can not exceed 60 bytes.
    storageSize Double
    Volume of CBS, and unit is GB.
    storageStatus String
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    storageType String
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    tags Map<String,String>
    The available tags within this CBS.
    throughputPerformance Double
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    attached boolean
    Indicates whether the CBS is mounted the CVM.
    availabilityZone string
    The available zone that the CBS instance locates at.
    cbsStorageId string
    ID of the resource.
    chargeType string
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    dedicatedClusterId string
    Exclusive cluster id.
    diskBackupQuota number
    The quota of backup points of cloud disk.
    encrypt boolean
    Pass in this parameter to create an encrypted cloud disk.
    forceDelete boolean
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    kmsKeyId string
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    period number
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    prepaidPeriod number
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    prepaidRenewFlag string
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    projectId number
    ID of the project to which the instance belongs.
    snapshotId string
    ID of the snapshot. If specified, created the CBS by this snapshot.
    storageName string
    Name of CBS. The maximum length can not exceed 60 bytes.
    storageSize number
    Volume of CBS, and unit is GB.
    storageStatus string
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    storageType string
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    tags {[key: string]: string}
    The available tags within this CBS.
    throughputPerformance number
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    attached bool
    Indicates whether the CBS is mounted the CVM.
    availability_zone str
    The available zone that the CBS instance locates at.
    cbs_storage_id str
    ID of the resource.
    charge_type str
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    dedicated_cluster_id str
    Exclusive cluster id.
    disk_backup_quota float
    The quota of backup points of cloud disk.
    encrypt bool
    Pass in this parameter to create an encrypted cloud disk.
    force_delete bool
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    kms_key_id str
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    period float
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    prepaid_period float
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    prepaid_renew_flag str
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    project_id float
    ID of the project to which the instance belongs.
    snapshot_id str
    ID of the snapshot. If specified, created the CBS by this snapshot.
    storage_name str
    Name of CBS. The maximum length can not exceed 60 bytes.
    storage_size float
    Volume of CBS, and unit is GB.
    storage_status str
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    storage_type str
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    tags Mapping[str, str]
    The available tags within this CBS.
    throughput_performance float
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.
    attached Boolean
    Indicates whether the CBS is mounted the CVM.
    availabilityZone String
    The available zone that the CBS instance locates at.
    cbsStorageId String
    ID of the resource.
    chargeType String
    The charge type of CBS instance. Valid values are PREPAID, POSTPAID_BY_HOUR, CDCPAID and DEDICATED_CLUSTER_PAID. The default is POSTPAID_BY_HOUR.
    dedicatedClusterId String
    Exclusive cluster id.
    diskBackupQuota Number
    The quota of backup points of cloud disk.
    encrypt Boolean
    Pass in this parameter to create an encrypted cloud disk.
    forceDelete Boolean
    Indicate whether to delete CBS instance directly or not. Default is false. If set true, the instance will be deleted instead of staying recycle bin.
    kmsKeyId String
    Optional parameters. When purchasing an encryption disk, customize the key. When this parameter is passed in, the encrypt parameter need be set.
    period Number
    It has been deprecated from version 1.33.0. Set prepaid_period instead. The purchased usage period of CBS. Valid values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36].

    Deprecated: Deprecated

    prepaidPeriod Number
    The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when charge_type is set to PREPAID. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    prepaidRenewFlag String
    Auto Renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically, DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically. NOTE: it only works when charge_type is set to PREPAID.
    projectId Number
    ID of the project to which the instance belongs.
    snapshotId String
    ID of the snapshot. If specified, created the CBS by this snapshot.
    storageName String
    Name of CBS. The maximum length can not exceed 60 bytes.
    storageSize Number
    Volume of CBS, and unit is GB.
    storageStatus String
    Status of CBS. Valid values: UNATTACHED, ATTACHING, ATTACHED, DETACHING, EXPANDING, ROLLBACKING, TORECYCLE and DUMPING.
    storageType String
    Type of CBS medium. Valid values: CLOUD_BASIC: HDD cloud disk, CLOUD_PREMIUM: Premium Cloud Storage, CLOUD_BSSD: General Purpose SSD, CLOUD_SSD: SSD, CLOUD_HSSD: Enhanced SSD, CLOUD_TSSD: Tremendous SSD.
    tags Map<String>
    The available tags within this CBS.
    throughputPerformance Number
    Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

    Import

    CBS storage can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/cbsStorage:CbsStorage example disk-41s6jwy4

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud