CloudinitDisk

libvirt 0.9.0, Nov 8 25

libvirt 0.9.0 published on Saturday, Nov 8, 2025 by dmacvicar

Schema (JSON)

dmacvicar/terraform-provider-libvirt

libvirt 0.9.0 published on Saturday, Nov 8, 2025 by dmacvicar

Schema (JSON)

dmacvicar/terraform-provider-libvirt

Create CloudinitDisk Resource

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

Constructor syntax

new CloudinitDisk(name: string, args: CloudinitDiskArgs, opts?: CustomResourceOptions);

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

@overload
def CloudinitDisk(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  meta_data: Optional[str] = None,
                  user_data: Optional[str] = None,
                  name: Optional[str] = None,
                  network_config: Optional[str] = None)

func NewCloudinitDisk(ctx *Context, name string, args CloudinitDiskArgs, opts ...ResourceOption) (*CloudinitDisk, error)

public CloudinitDisk(string name, CloudinitDiskArgs args, CustomResourceOptions? opts = null)

public CloudinitDisk(String name, CloudinitDiskArgs args)
public CloudinitDisk(String name, CloudinitDiskArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args CloudinitDiskArgs: 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 cloudinitDiskResource = new Libvirt.CloudinitDisk("cloudinitDiskResource", new()
{
    MetaData = "string",
    UserData = "string",
    Name = "string",
    NetworkConfig = "string",
});

example, err := libvirt.NewCloudinitDisk(ctx, "cloudinitDiskResource", &libvirt.CloudinitDiskArgs{
	MetaData:      pulumi.String("string"),
	UserData:      pulumi.String("string"),
	Name:          pulumi.String("string"),
	NetworkConfig: pulumi.String("string"),
})

var cloudinitDiskResource = new CloudinitDisk("cloudinitDiskResource", CloudinitDiskArgs.builder()
    .metaData("string")
    .userData("string")
    .name("string")
    .networkConfig("string")
    .build());

cloudinit_disk_resource = libvirt.CloudinitDisk("cloudinitDiskResource",
    meta_data="string",
    user_data="string",
    name="string",
    network_config="string")

const cloudinitDiskResource = new libvirt.CloudinitDisk("cloudinitDiskResource", {
    metaData: "string",
    userData: "string",
    name: "string",
    networkConfig: "string",
});

type: libvirt:CloudinitDisk
properties:
    metaData: string
    name: string
    networkConfig: string
    userData: string

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

MetaData string: Cloud-init meta-data content (usually YAML)
UserData string: Cloud-init user-data content (usually YAML)
Name string: Name for this cloud-init disk resource
NetworkConfig string: Cloud-init network configuration (optional, usually YAML)

MetaData string: Cloud-init meta-data content (usually YAML)
UserData string: Cloud-init user-data content (usually YAML)
Name string: Name for this cloud-init disk resource
NetworkConfig string: Cloud-init network configuration (optional, usually YAML)

metaData String: Cloud-init meta-data content (usually YAML)
userData String: Cloud-init user-data content (usually YAML)
name String: Name for this cloud-init disk resource
networkConfig String: Cloud-init network configuration (optional, usually YAML)

metaData string: Cloud-init meta-data content (usually YAML)
userData string: Cloud-init user-data content (usually YAML)
name string: Name for this cloud-init disk resource
networkConfig string: Cloud-init network configuration (optional, usually YAML)

meta_data str: Cloud-init meta-data content (usually YAML)
user_data str: Cloud-init user-data content (usually YAML)
name str: Name for this cloud-init disk resource
network_config str: Cloud-init network configuration (optional, usually YAML)

metaData String: Cloud-init meta-data content (usually YAML)
userData String: Cloud-init user-data content (usually YAML)
name String: Name for this cloud-init disk resource
networkConfig String: Cloud-init network configuration (optional, usually YAML)

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Path string: Full path to the generated ISO file
Size double: Size of the ISO file in bytes

Id string: The provider-assigned unique ID for this managed resource.
Path string: Full path to the generated ISO file
Size float64: Size of the ISO file in bytes

id String: The provider-assigned unique ID for this managed resource.
path String: Full path to the generated ISO file
size Double: Size of the ISO file in bytes

id string: The provider-assigned unique ID for this managed resource.
path string: Full path to the generated ISO file
size number: Size of the ISO file in bytes

id str: The provider-assigned unique ID for this managed resource.
path str: Full path to the generated ISO file
size float: Size of the ISO file in bytes

id String: The provider-assigned unique ID for this managed resource.
path String: Full path to the generated ISO file
size Number: Size of the ISO file in bytes

Look up Existing CloudinitDisk Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        meta_data: Optional[str] = None,
        name: Optional[str] = None,
        network_config: Optional[str] = None,
        path: Optional[str] = None,
        size: Optional[float] = None,
        user_data: Optional[str] = None) -> CloudinitDisk

func GetCloudinitDisk(ctx *Context, name string, id IDInput, state *CloudinitDiskState, opts ...ResourceOption) (*CloudinitDisk, error)

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

public static CloudinitDisk get(String name, Output<String> id, CloudinitDiskState state, CustomResourceOptions options)

resources:  _:    type: libvirt:CloudinitDisk    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:

MetaData string: Cloud-init meta-data content (usually YAML)
Name string: Name for this cloud-init disk resource
NetworkConfig string: Cloud-init network configuration (optional, usually YAML)
Path string: Full path to the generated ISO file
Size double: Size of the ISO file in bytes
UserData string: Cloud-init user-data content (usually YAML)

MetaData string: Cloud-init meta-data content (usually YAML)
Name string: Name for this cloud-init disk resource
NetworkConfig string: Cloud-init network configuration (optional, usually YAML)
Path string: Full path to the generated ISO file
Size float64: Size of the ISO file in bytes
UserData string: Cloud-init user-data content (usually YAML)

metaData String: Cloud-init meta-data content (usually YAML)
name String: Name for this cloud-init disk resource
networkConfig String: Cloud-init network configuration (optional, usually YAML)
path String: Full path to the generated ISO file
size Double: Size of the ISO file in bytes
userData String: Cloud-init user-data content (usually YAML)

metaData string: Cloud-init meta-data content (usually YAML)
name string: Name for this cloud-init disk resource
networkConfig string: Cloud-init network configuration (optional, usually YAML)
path string: Full path to the generated ISO file
size number: Size of the ISO file in bytes
userData string: Cloud-init user-data content (usually YAML)

meta_data str: Cloud-init meta-data content (usually YAML)
name str: Name for this cloud-init disk resource
network_config str: Cloud-init network configuration (optional, usually YAML)
path str: Full path to the generated ISO file
size float: Size of the ISO file in bytes
user_data str: Cloud-init user-data content (usually YAML)

metaData String: Cloud-init meta-data content (usually YAML)
name String: Name for this cloud-init disk resource
networkConfig String: Cloud-init network configuration (optional, usually YAML)
path String: Full path to the generated ISO file
size Number: Size of the ISO file in bytes
userData String: Cloud-init user-data content (usually YAML)