Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. CustomAttribute
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.CustomAttribute

Explore with Pulumi AI

vsphere logo
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

    The vsphere.CustomAttribute resource can be used to create and manage custom attributes, which allow users to associate user-specific meta-information with vSphere managed objects. Custom attribute values must be strings and are stored on the vCenter Server and not the managed object.

    For more information about custom attributes, click here.

    NOTE: Custom attributes are unsupported on direct ESXi host connections and require vCenter Server.

    Example Usage

    This example creates a custom attribute named test-attribute. The resulting custom attribute can be assigned to VMs only.

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

const attribute = new vsphere.CustomAttribute("attribute", {
    name: "test-attribute",
    managedObjectType: "VirtualMachine",
});

    import pulumi
import pulumi_vsphere as vsphere

attribute = vsphere.CustomAttribute("attribute",
    name="test-attribute",
    managed_object_type="VirtualMachine")

    package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vsphere.NewCustomAttribute(ctx, "attribute", &vsphere.CustomAttributeArgs{
			Name:              pulumi.String("test-attribute"),
			ManagedObjectType: pulumi.String("VirtualMachine"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var attribute = new VSphere.CustomAttribute("attribute", new()
    {
        Name = "test-attribute",
        ManagedObjectType = "VirtualMachine",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.CustomAttribute;
import com.pulumi.vsphere.CustomAttributeArgs;
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 attribute = new CustomAttribute("attribute", CustomAttributeArgs.builder()
            .name("test-attribute")
            .managedObjectType("VirtualMachine")
            .build());

    }
}

    resources:
  attribute:
    type: vsphere:CustomAttribute
    properties:
      name: test-attribute
      managedObjectType: VirtualMachine

    Create CustomAttribute Resource

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

    Constructor syntax

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

@overload
def CustomAttribute(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    managed_object_type: Optional[str] = None,
                    name: Optional[str] = None)
    func NewCustomAttribute(ctx *Context, name string, args *CustomAttributeArgs, opts ...ResourceOption) (*CustomAttribute, error)
    public CustomAttribute(string name, CustomAttributeArgs? args = null, CustomResourceOptions? opts = null)
    public CustomAttribute(String name, CustomAttributeArgs args)
public CustomAttribute(String name, CustomAttributeArgs args, CustomResourceOptions options)

    type: vsphere:CustomAttribute
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 CustomAttributeArgs
    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 CustomAttributeArgs
    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 CustomAttributeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomAttributeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomAttributeArgs
    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 customAttributeResource = new VSphere.CustomAttribute("customAttributeResource", new()
{
    ManagedObjectType = "string",
    Name = "string",
});

    example, err := vsphere.NewCustomAttribute(ctx, "customAttributeResource", &vsphere.CustomAttributeArgs{
	ManagedObjectType: pulumi.String("string"),
	Name:              pulumi.String("string"),
})

    var customAttributeResource = new CustomAttribute("customAttributeResource", CustomAttributeArgs.builder()
    .managedObjectType("string")
    .name("string")
    .build());

    custom_attribute_resource = vsphere.CustomAttribute("customAttributeResource",
    managed_object_type="string",
    name="string")

    const customAttributeResource = new vsphere.CustomAttribute("customAttributeResource", {
    managedObjectType: "string",
    name: "string",
});

    type: vsphere:CustomAttribute
properties:
    managedObjectType: string
    name: string

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

    ManagedObjectType string
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    Name string
    The name of the custom attribute.
    ManagedObjectType string
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    Name string
    The name of the custom attribute.
    managedObjectType String
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    name String
    The name of the custom attribute.
    managedObjectType string
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    name string
    The name of the custom attribute.
    managed_object_type str
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    name str
    The name of the custom attribute.
    managedObjectType String
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    name String
    The name of the custom attribute.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomAttribute Resource

    Get an existing CustomAttribute 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?: CustomAttributeState, opts?: CustomResourceOptions): CustomAttribute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        managed_object_type: Optional[str] = None,
        name: Optional[str] = None) -> CustomAttribute
    func GetCustomAttribute(ctx *Context, name string, id IDInput, state *CustomAttributeState, opts ...ResourceOption) (*CustomAttribute, error)
    public static CustomAttribute Get(string name, Input<string> id, CustomAttributeState? state, CustomResourceOptions? opts = null)
    public static CustomAttribute get(String name, Output<String> id, CustomAttributeState state, CustomResourceOptions options)
    resources:  _:    type: vsphere:CustomAttribute    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:
    ManagedObjectType string
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    Name string
    The name of the custom attribute.
    ManagedObjectType string
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    Name string
    The name of the custom attribute.
    managedObjectType String
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    name String
    The name of the custom attribute.
    managedObjectType string
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    name string
    The name of the custom attribute.
    managed_object_type str
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    name str
    The name of the custom attribute.
    managedObjectType String
    The object type that this attribute may be applied to. If not set, the custom attribute may be applied to any object type. For a full list, review the Managed Object Types. Forces a new resource if changed.
    name String
    The name of the custom attribute.

    Import

    An existing custom attribute can be imported into this resource

    via its name, using the following command:

    $ pulumi import vsphere:index/customAttribute:CustomAttribute attribute terraform-test-attribute

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

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
    pulumi/pulumi-vsphere