Docs Packages
  1. Packages
  2. vSphere
  3. API Docs
  4. CustomAttribute
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-vsphere

vsphere.CustomAttribute

Explore with Pulumi AI

vsphere logo
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-vsphere

    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

    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)
    Resource lookup is not supported in YAML
    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.

    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.10.1 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-vsphere