1. Packages
  2. Nutanix
  3. API Docs
  4. CategoryKey
Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg

nutanix.CategoryKey

Explore with Pulumi AI

nutanix logo
Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg

    Provides a Nutanix Category key resource to Create a category key name.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pierskarsenbarg/nutanix";
    
    const test = new nutanix.CategoryKey("test", {description: "App Support Category Key"});
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    test = nutanix.CategoryKey("test", description="App Support Category Key")
    
    package main
    
    import (
    	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nutanix.NewCategoryKey(ctx, "test", &nutanix.CategoryKeyArgs{
    			Description: pulumi.String("App Support Category Key"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = PiersKarsenbarg.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Nutanix.CategoryKey("test", new()
        {
            Description = "App Support Category Key",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.CategoryKey;
    import com.pulumi.nutanix.CategoryKeyArgs;
    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 test = new CategoryKey("test", CategoryKeyArgs.builder()
                .description("App Support Category Key")
                .build());
    
        }
    }
    
    resources:
      test:
        type: nutanix:CategoryKey
        properties:
          description: App Support Category Key
    

    Create CategoryKey Resource

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

    Constructor syntax

    new CategoryKey(name: string, args?: CategoryKeyArgs, opts?: CustomResourceOptions);
    @overload
    def CategoryKey(resource_name: str,
                    args: Optional[CategoryKeyArgs] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def CategoryKey(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None)
    func NewCategoryKey(ctx *Context, name string, args *CategoryKeyArgs, opts ...ResourceOption) (*CategoryKey, error)
    public CategoryKey(string name, CategoryKeyArgs? args = null, CustomResourceOptions? opts = null)
    public CategoryKey(String name, CategoryKeyArgs args)
    public CategoryKey(String name, CategoryKeyArgs args, CustomResourceOptions options)
    
    type: nutanix:CategoryKey
    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 CategoryKeyArgs
    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 CategoryKeyArgs
    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 CategoryKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CategoryKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CategoryKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var categoryKeyResource = new Nutanix.CategoryKey("categoryKeyResource", new()
    {
        Description = "string",
        Name = "string",
    });
    
    example, err := nutanix.NewCategoryKey(ctx, "categoryKeyResource", &nutanix.CategoryKeyArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var categoryKeyResource = new CategoryKey("categoryKeyResource", CategoryKeyArgs.builder()
        .description("string")
        .name("string")
        .build());
    
    category_key_resource = nutanix.CategoryKey("categoryKeyResource",
        description="string",
        name="string")
    
    const categoryKeyResource = new nutanix.CategoryKey("categoryKeyResource", {
        description: "string",
        name: "string",
    });
    
    type: nutanix:CategoryKey
    properties:
        description: string
        name: string
    

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

    Description string
    • (Optional) A description for category key.
    Name string
    • (Required) The name for the category key.
    Description string
    • (Optional) A description for category key.
    Name string
    • (Required) The name for the category key.
    description String
    • (Optional) A description for category key.
    name String
    • (Required) The name for the category key.
    description string
    • (Optional) A description for category key.
    name string
    • (Required) The name for the category key.
    description str
    • (Optional) A description for category key.
    name str
    • (Required) The name for the category key.
    description String
    • (Optional) A description for category key.
    name String
    • (Required) The name for the category key.

    Outputs

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

    ApiVersion string
    (Optional) The version of the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemDefined bool
    • Specifying whether its a system defined category.
    ApiVersion string
    (Optional) The version of the API.
    Id string
    The provider-assigned unique ID for this managed resource.
    SystemDefined bool
    • Specifying whether its a system defined category.
    apiVersion String
    (Optional) The version of the API.
    id String
    The provider-assigned unique ID for this managed resource.
    systemDefined Boolean
    • Specifying whether its a system defined category.
    apiVersion string
    (Optional) The version of the API.
    id string
    The provider-assigned unique ID for this managed resource.
    systemDefined boolean
    • Specifying whether its a system defined category.
    api_version str
    (Optional) The version of the API.
    id str
    The provider-assigned unique ID for this managed resource.
    system_defined bool
    • Specifying whether its a system defined category.
    apiVersion String
    (Optional) The version of the API.
    id String
    The provider-assigned unique ID for this managed resource.
    systemDefined Boolean
    • Specifying whether its a system defined category.

    Look up Existing CategoryKey Resource

    Get an existing CategoryKey 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?: CategoryKeyState, opts?: CustomResourceOptions): CategoryKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_version: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            system_defined: Optional[bool] = None) -> CategoryKey
    func GetCategoryKey(ctx *Context, name string, id IDInput, state *CategoryKeyState, opts ...ResourceOption) (*CategoryKey, error)
    public static CategoryKey Get(string name, Input<string> id, CategoryKeyState? state, CustomResourceOptions? opts = null)
    public static CategoryKey get(String name, Output<String> id, CategoryKeyState 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:
    ApiVersion string
    (Optional) The version of the API.
    Description string
    • (Optional) A description for category key.
    Name string
    • (Required) The name for the category key.
    SystemDefined bool
    • Specifying whether its a system defined category.
    ApiVersion string
    (Optional) The version of the API.
    Description string
    • (Optional) A description for category key.
    Name string
    • (Required) The name for the category key.
    SystemDefined bool
    • Specifying whether its a system defined category.
    apiVersion String
    (Optional) The version of the API.
    description String
    • (Optional) A description for category key.
    name String
    • (Required) The name for the category key.
    systemDefined Boolean
    • Specifying whether its a system defined category.
    apiVersion string
    (Optional) The version of the API.
    description string
    • (Optional) A description for category key.
    name string
    • (Required) The name for the category key.
    systemDefined boolean
    • Specifying whether its a system defined category.
    api_version str
    (Optional) The version of the API.
    description str
    • (Optional) A description for category key.
    name str
    • (Required) The name for the category key.
    system_defined bool
    • Specifying whether its a system defined category.
    apiVersion String
    (Optional) The version of the API.
    description String
    • (Optional) A description for category key.
    name String
    • (Required) The name for the category key.
    systemDefined Boolean
    • Specifying whether its a system defined category.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg