Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. VolumeSet
Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse
pulumiverse/pulumi-cpln

cpln.VolumeSet

Explore with Pulumi AI

cpln logo
Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse
pulumiverse/pulumi-cpln

    Create VolumeSet Resource

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

    Constructor syntax

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

@overload
def VolumeSet(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              gvc: Optional[str] = None,
              initial_capacity: Optional[int] = None,
              performance_class: Optional[str] = None,
              autoscaling: Optional[VolumeSetAutoscalingArgs] = None,
              description: Optional[str] = None,
              file_system_type: Optional[str] = None,
              name: Optional[str] = None,
              snapshots: Optional[VolumeSetSnapshotsArgs] = None,
              storage_class_suffix: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
    func NewVolumeSet(ctx *Context, name string, args VolumeSetArgs, opts ...ResourceOption) (*VolumeSet, error)
    public VolumeSet(string name, VolumeSetArgs args, CustomResourceOptions? opts = null)
    public VolumeSet(String name, VolumeSetArgs args)
public VolumeSet(String name, VolumeSetArgs args, CustomResourceOptions options)

    type: cpln:VolumeSet
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 VolumeSetArgs
    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 VolumeSetArgs
    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 VolumeSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeSetArgs
    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 volumeSetResource = new Cpln.VolumeSet("volumeSetResource", new()
{
    Gvc = "string",
    InitialCapacity = 0,
    PerformanceClass = "string",
    Autoscaling = new Cpln.Inputs.VolumeSetAutoscalingArgs
    {
        MaxCapacity = 0,
        MinFreePercentage = 0,
        ScalingFactor = 0,
    },
    Description = "string",
    FileSystemType = "string",
    Name = "string",
    Snapshots = new Cpln.Inputs.VolumeSetSnapshotsArgs
    {
        CreateFinalSnapshot = false,
        RetentionDuration = "string",
        Schedule = "string",
    },
    StorageClassSuffix = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cpln.NewVolumeSet(ctx, "volumeSetResource", &cpln.VolumeSetArgs{
	Gvc:              pulumi.String("string"),
	InitialCapacity:  pulumi.Int(0),
	PerformanceClass: pulumi.String("string"),
	Autoscaling: &cpln.VolumeSetAutoscalingArgs{
		MaxCapacity:       pulumi.Int(0),
		MinFreePercentage: pulumi.Int(0),
		ScalingFactor:     pulumi.Float64(0),
	},
	Description:    pulumi.String("string"),
	FileSystemType: pulumi.String("string"),
	Name:           pulumi.String("string"),
	Snapshots: &cpln.VolumeSetSnapshotsArgs{
		CreateFinalSnapshot: pulumi.Bool(false),
		RetentionDuration:   pulumi.String("string"),
		Schedule:            pulumi.String("string"),
	},
	StorageClassSuffix: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var volumeSetResource = new VolumeSet("volumeSetResource", VolumeSetArgs.builder()
    .gvc("string")
    .initialCapacity(0)
    .performanceClass("string")
    .autoscaling(VolumeSetAutoscalingArgs.builder()
        .maxCapacity(0)
        .minFreePercentage(0)
        .scalingFactor(0)
        .build())
    .description("string")
    .fileSystemType("string")
    .name("string")
    .snapshots(VolumeSetSnapshotsArgs.builder()
        .createFinalSnapshot(false)
        .retentionDuration("string")
        .schedule("string")
        .build())
    .storageClassSuffix("string")
    .tags(Map.of("string", "string"))
    .build());

    volume_set_resource = cpln.VolumeSet("volumeSetResource",
    gvc="string",
    initial_capacity=0,
    performance_class="string",
    autoscaling={
        "max_capacity": 0,
        "min_free_percentage": 0,
        "scaling_factor": 0,
    },
    description="string",
    file_system_type="string",
    name="string",
    snapshots={
        "create_final_snapshot": False,
        "retention_duration": "string",
        "schedule": "string",
    },
    storage_class_suffix="string",
    tags={
        "string": "string",
    })

    const volumeSetResource = new cpln.VolumeSet("volumeSetResource", {
    gvc: "string",
    initialCapacity: 0,
    performanceClass: "string",
    autoscaling: {
        maxCapacity: 0,
        minFreePercentage: 0,
        scalingFactor: 0,
    },
    description: "string",
    fileSystemType: "string",
    name: "string",
    snapshots: {
        createFinalSnapshot: false,
        retentionDuration: "string",
        schedule: "string",
    },
    storageClassSuffix: "string",
    tags: {
        string: "string",
    },
});

    type: cpln:VolumeSet
properties:
    autoscaling:
        maxCapacity: 0
        minFreePercentage: 0
        scalingFactor: 0
    description: string
    fileSystemType: string
    gvc: string
    initialCapacity: 0
    name: string
    performanceClass: string
    snapshots:
        createFinalSnapshot: false
        retentionDuration: string
        schedule: string
    storageClassSuffix: string
    tags:
        string: string

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

    Gvc string
    Name of the associated GVC.
    InitialCapacity int
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    PerformanceClass string
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    Autoscaling Pulumiverse.Cpln.Inputs.VolumeSetAutoscaling
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    Description string
    Description of the Volume Set.
    FileSystemType string
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    Name string
    Name of the Volume Set.
    Snapshots Pulumiverse.Cpln.Inputs.VolumeSetSnapshots
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    StorageClassSuffix string
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    Gvc string
    Name of the associated GVC.
    InitialCapacity int
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    PerformanceClass string
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    Autoscaling VolumeSetAutoscalingArgs
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    Description string
    Description of the Volume Set.
    FileSystemType string
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    Name string
    Name of the Volume Set.
    Snapshots VolumeSetSnapshotsArgs
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    StorageClassSuffix string
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    Tags map[string]string
    Key-value map of resource tags.
    gvc String
    Name of the associated GVC.
    initialCapacity Integer
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    performanceClass String
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    autoscaling VolumeSetAutoscaling
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    description String
    Description of the Volume Set.
    fileSystemType String
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    name String
    Name of the Volume Set.
    snapshots VolumeSetSnapshots
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    storageClassSuffix String
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    tags Map<String,String>
    Key-value map of resource tags.
    gvc string
    Name of the associated GVC.
    initialCapacity number
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    performanceClass string
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    autoscaling VolumeSetAutoscaling
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    description string
    Description of the Volume Set.
    fileSystemType string
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    name string
    Name of the Volume Set.
    snapshots VolumeSetSnapshots
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    storageClassSuffix string
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    tags {[key: string]: string}
    Key-value map of resource tags.
    gvc str
    Name of the associated GVC.
    initial_capacity int
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    performance_class str
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    autoscaling VolumeSetAutoscalingArgs
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    description str
    Description of the Volume Set.
    file_system_type str
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    name str
    Name of the Volume Set.
    snapshots VolumeSetSnapshotsArgs
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    storage_class_suffix str
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    tags Mapping[str, str]
    Key-value map of resource tags.
    gvc String
    Name of the associated GVC.
    initialCapacity Number
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    performanceClass String
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    autoscaling Property Map
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    description String
    Description of the Volume Set.
    fileSystemType String
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    name String
    Name of the Volume Set.
    snapshots Property Map
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    storageClassSuffix String
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    tags Map<String>
    Key-value map of resource tags.

    Outputs

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

    CplnId string
    ID, in GUID format, of the Volume Set.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses List<Pulumiverse.Cpln.Outputs.VolumeSetStatus>
    Status of the Volume Set.
    VolumesetLink string
    Output used when linking a volume set to a workload.
    CplnId string
    ID, in GUID format, of the Volume Set.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Statuses []VolumeSetStatus
    Status of the Volume Set.
    VolumesetLink string
    Output used when linking a volume set to a workload.
    cplnId String
    ID, in GUID format, of the Volume Set.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<VolumeSetStatus>
    Status of the Volume Set.
    volumesetLink String
    Output used when linking a volume set to a workload.
    cplnId string
    ID, in GUID format, of the Volume Set.
    id string
    The provider-assigned unique ID for this managed resource.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    statuses VolumeSetStatus[]
    Status of the Volume Set.
    volumesetLink string
    Output used when linking a volume set to a workload.
    cpln_id str
    ID, in GUID format, of the Volume Set.
    id str
    The provider-assigned unique ID for this managed resource.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    statuses Sequence[VolumeSetStatus]
    Status of the Volume Set.
    volumeset_link str
    Output used when linking a volume set to a workload.
    cplnId String
    ID, in GUID format, of the Volume Set.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    statuses List<Property Map>
    Status of the Volume Set.
    volumesetLink String
    Output used when linking a volume set to a workload.

    Look up Existing VolumeSet Resource

    Get an existing VolumeSet 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?: VolumeSetState, opts?: CustomResourceOptions): VolumeSet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autoscaling: Optional[VolumeSetAutoscalingArgs] = None,
        cpln_id: Optional[str] = None,
        description: Optional[str] = None,
        file_system_type: Optional[str] = None,
        gvc: Optional[str] = None,
        initial_capacity: Optional[int] = None,
        name: Optional[str] = None,
        performance_class: Optional[str] = None,
        self_link: Optional[str] = None,
        snapshots: Optional[VolumeSetSnapshotsArgs] = None,
        statuses: Optional[Sequence[VolumeSetStatusArgs]] = None,
        storage_class_suffix: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        volumeset_link: Optional[str] = None) -> VolumeSet
    func GetVolumeSet(ctx *Context, name string, id IDInput, state *VolumeSetState, opts ...ResourceOption) (*VolumeSet, error)
    public static VolumeSet Get(string name, Input<string> id, VolumeSetState? state, CustomResourceOptions? opts = null)
    public static VolumeSet get(String name, Output<String> id, VolumeSetState state, CustomResourceOptions options)
    resources:  _:    type: cpln:VolumeSet    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:
    Autoscaling Pulumiverse.Cpln.Inputs.VolumeSetAutoscaling
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    CplnId string
    ID, in GUID format, of the Volume Set.
    Description string
    Description of the Volume Set.
    FileSystemType string
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    Gvc string
    Name of the associated GVC.
    InitialCapacity int
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    Name string
    Name of the Volume Set.
    PerformanceClass string
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Snapshots Pulumiverse.Cpln.Inputs.VolumeSetSnapshots
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    Statuses List<Pulumiverse.Cpln.Inputs.VolumeSetStatus>
    Status of the Volume Set.
    StorageClassSuffix string
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    VolumesetLink string
    Output used when linking a volume set to a workload.
    Autoscaling VolumeSetAutoscalingArgs
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    CplnId string
    ID, in GUID format, of the Volume Set.
    Description string
    Description of the Volume Set.
    FileSystemType string
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    Gvc string
    Name of the associated GVC.
    InitialCapacity int
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    Name string
    Name of the Volume Set.
    PerformanceClass string
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Snapshots VolumeSetSnapshotsArgs
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    Statuses []VolumeSetStatusArgs
    Status of the Volume Set.
    StorageClassSuffix string
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    Tags map[string]string
    Key-value map of resource tags.
    VolumesetLink string
    Output used when linking a volume set to a workload.
    autoscaling VolumeSetAutoscaling
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    cplnId String
    ID, in GUID format, of the Volume Set.
    description String
    Description of the Volume Set.
    fileSystemType String
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    gvc String
    Name of the associated GVC.
    initialCapacity Integer
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    name String
    Name of the Volume Set.
    performanceClass String
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    snapshots VolumeSetSnapshots
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    statuses List<VolumeSetStatus>
    Status of the Volume Set.
    storageClassSuffix String
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    tags Map<String,String>
    Key-value map of resource tags.
    volumesetLink String
    Output used when linking a volume set to a workload.
    autoscaling VolumeSetAutoscaling
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    cplnId string
    ID, in GUID format, of the Volume Set.
    description string
    Description of the Volume Set.
    fileSystemType string
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    gvc string
    Name of the associated GVC.
    initialCapacity number
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    name string
    Name of the Volume Set.
    performanceClass string
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    snapshots VolumeSetSnapshots
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    statuses VolumeSetStatus[]
    Status of the Volume Set.
    storageClassSuffix string
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    tags {[key: string]: string}
    Key-value map of resource tags.
    volumesetLink string
    Output used when linking a volume set to a workload.
    autoscaling VolumeSetAutoscalingArgs
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    cpln_id str
    ID, in GUID format, of the Volume Set.
    description str
    Description of the Volume Set.
    file_system_type str
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    gvc str
    Name of the associated GVC.
    initial_capacity int
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    name str
    Name of the Volume Set.
    performance_class str
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    self_link str
    Full link to this resource. Can be referenced by other resources.
    snapshots VolumeSetSnapshotsArgs
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    statuses Sequence[VolumeSetStatusArgs]
    Status of the Volume Set.
    storage_class_suffix str
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    tags Mapping[str, str]
    Key-value map of resource tags.
    volumeset_link str
    Output used when linking a volume set to a workload.
    autoscaling Property Map
    Automated adjustment of the volume set's capacity based on predefined metrics or conditions.
    cplnId String
    ID, in GUID format, of the Volume Set.
    description String
    Description of the Volume Set.
    fileSystemType String
    Each volume set has a single, immutable file system. Valid types: xfs or ext4
    gvc String
    Name of the associated GVC.
    initialCapacity Number
    The initial volume size in this set, specified in GB. The minimum size for the performance class general-purpose-ssd is 10 GB, while high-throughput-ssd requires at least 200 GB.
    name String
    Name of the Volume Set.
    performanceClass String
    Each volume set has a single, immutable, performance class. Valid classes: general-purpose-ssd or high-throughput-ssd
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    snapshots Property Map
    Point-in-time copies of data stored within the volume set, capturing the state of the data at a specific moment.
    statuses List<Property Map>
    Status of the Volume Set.
    storageClassSuffix String
    For self-hosted locations only. The storage class used for volumes in this set will be {performanceClass}-{fileSystemType}-{storageClassSuffix} if it exists, otherwise it will be {performanceClass}-{fileSystemType}
    tags Map<String>
    Key-value map of resource tags.
    volumesetLink String
    Output used when linking a volume set to a workload.

    Supporting Types

    VolumeSetAutoscaling, VolumeSetAutoscalingArgs

    MaxCapacity int
    The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this value. Minimum value: 10.
    MinFreePercentage int
    The guaranteed free space on the volume as a percentage of the volume's total size. Control Plane will try to maintain at least that many percent free by scaling up the total size. Minimum percentage: 1. Maximum Percentage: 100.
    ScalingFactor double
    When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor. Minimum value: 1.1.
    MaxCapacity int
    The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this value. Minimum value: 10.
    MinFreePercentage int
    The guaranteed free space on the volume as a percentage of the volume's total size. Control Plane will try to maintain at least that many percent free by scaling up the total size. Minimum percentage: 1. Maximum Percentage: 100.
    ScalingFactor float64
    When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor. Minimum value: 1.1.
    maxCapacity Integer
    The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this value. Minimum value: 10.
    minFreePercentage Integer
    The guaranteed free space on the volume as a percentage of the volume's total size. Control Plane will try to maintain at least that many percent free by scaling up the total size. Minimum percentage: 1. Maximum Percentage: 100.
    scalingFactor Double
    When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor. Minimum value: 1.1.
    maxCapacity number
    The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this value. Minimum value: 10.
    minFreePercentage number
    The guaranteed free space on the volume as a percentage of the volume's total size. Control Plane will try to maintain at least that many percent free by scaling up the total size. Minimum percentage: 1. Maximum Percentage: 100.
    scalingFactor number
    When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor. Minimum value: 1.1.
    max_capacity int
    The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this value. Minimum value: 10.
    min_free_percentage int
    The guaranteed free space on the volume as a percentage of the volume's total size. Control Plane will try to maintain at least that many percent free by scaling up the total size. Minimum percentage: 1. Maximum Percentage: 100.
    scaling_factor float
    When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor. Minimum value: 1.1.
    maxCapacity Number
    The maximum size in GB for a volume in this set. A volume cannot grow to be bigger than this value. Minimum value: 10.
    minFreePercentage Number
    The guaranteed free space on the volume as a percentage of the volume's total size. Control Plane will try to maintain at least that many percent free by scaling up the total size. Minimum percentage: 1. Maximum Percentage: 100.
    scalingFactor Number
    When scaling is necessary, then new_capacity = current_capacity * storageScalingFactor. Minimum value: 1.1.

    VolumeSetSnapshots, VolumeSetSnapshotsArgs

    CreateFinalSnapshot bool
    If true, a volume snapshot will be created immediately before deletion of any volume in this set. Default: true
    RetentionDuration string
    The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
    Schedule string
    A standard cron schedule expression used to determine when a snapshot will be taken. (i.e., 0 * * * * Every hour). Note: snapshots cannot be scheduled more often than once per hour.
    CreateFinalSnapshot bool
    If true, a volume snapshot will be created immediately before deletion of any volume in this set. Default: true
    RetentionDuration string
    The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
    Schedule string
    A standard cron schedule expression used to determine when a snapshot will be taken. (i.e., 0 * * * * Every hour). Note: snapshots cannot be scheduled more often than once per hour.
    createFinalSnapshot Boolean
    If true, a volume snapshot will be created immediately before deletion of any volume in this set. Default: true
    retentionDuration String
    The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
    schedule String
    A standard cron schedule expression used to determine when a snapshot will be taken. (i.e., 0 * * * * Every hour). Note: snapshots cannot be scheduled more often than once per hour.
    createFinalSnapshot boolean
    If true, a volume snapshot will be created immediately before deletion of any volume in this set. Default: true
    retentionDuration string
    The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
    schedule string
    A standard cron schedule expression used to determine when a snapshot will be taken. (i.e., 0 * * * * Every hour). Note: snapshots cannot be scheduled more often than once per hour.
    create_final_snapshot bool
    If true, a volume snapshot will be created immediately before deletion of any volume in this set. Default: true
    retention_duration str
    The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
    schedule str
    A standard cron schedule expression used to determine when a snapshot will be taken. (i.e., 0 * * * * Every hour). Note: snapshots cannot be scheduled more often than once per hour.
    createFinalSnapshot Boolean
    If true, a volume snapshot will be created immediately before deletion of any volume in this set. Default: true
    retentionDuration String
    The default retention period for volume snapshots. This string should contain a floating point number followed by either d, h, or m. For example, "10d" would retain snapshots for 10 days.
    schedule String
    A standard cron schedule expression used to determine when a snapshot will be taken. (i.e., 0 * * * * Every hour). Note: snapshots cannot be scheduled more often than once per hour.

    VolumeSetStatus, VolumeSetStatusArgs

    BindingId string
    Uniquely identifies the connection between the volume set and its workload. Every time a new connection is made, a new id is generated (e.g., If a workload is updated to remove the volume set, then updated again to reattach it, the volume set will have a new binding id).
    Locations List<string>
    Contains a list of actual volumes grouped by location.
    ParentId string
    The GVC ID.
    UsedByWorkload string
    The url of the workload currently using this volume set (if any).
    BindingId string
    Uniquely identifies the connection between the volume set and its workload. Every time a new connection is made, a new id is generated (e.g., If a workload is updated to remove the volume set, then updated again to reattach it, the volume set will have a new binding id).
    Locations []string
    Contains a list of actual volumes grouped by location.
    ParentId string
    The GVC ID.
    UsedByWorkload string
    The url of the workload currently using this volume set (if any).
    bindingId String
    Uniquely identifies the connection between the volume set and its workload. Every time a new connection is made, a new id is generated (e.g., If a workload is updated to remove the volume set, then updated again to reattach it, the volume set will have a new binding id).
    locations List<String>
    Contains a list of actual volumes grouped by location.
    parentId String
    The GVC ID.
    usedByWorkload String
    The url of the workload currently using this volume set (if any).
    bindingId string
    Uniquely identifies the connection between the volume set and its workload. Every time a new connection is made, a new id is generated (e.g., If a workload is updated to remove the volume set, then updated again to reattach it, the volume set will have a new binding id).
    locations string[]
    Contains a list of actual volumes grouped by location.
    parentId string
    The GVC ID.
    usedByWorkload string
    The url of the workload currently using this volume set (if any).
    binding_id str
    Uniquely identifies the connection between the volume set and its workload. Every time a new connection is made, a new id is generated (e.g., If a workload is updated to remove the volume set, then updated again to reattach it, the volume set will have a new binding id).
    locations Sequence[str]
    Contains a list of actual volumes grouped by location.
    parent_id str
    The GVC ID.
    used_by_workload str
    The url of the workload currently using this volume set (if any).
    bindingId String
    Uniquely identifies the connection between the volume set and its workload. Every time a new connection is made, a new id is generated (e.g., If a workload is updated to remove the volume set, then updated again to reattach it, the volume set will have a new binding id).
    locations List<String>
    Contains a list of actual volumes grouped by location.
    parentId String
    The GVC ID.
    usedByWorkload String
    The url of the workload currently using this volume set (if any).

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.55 published on Thursday, Mar 27, 2025 by pulumiverse
    pulumiverse/pulumi-cpln