1. Packages
  2. Nutanix
  3. API Docs
  4. NdbTag
Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

nutanix.NdbTag

Explore with Pulumi AI

nutanix logo
Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

    Provides a resource to create tags based on the input parameters.

    Example Usage

    resource to create tag

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pierskarsenbarg/nutanix";
    
    const name = new nutanix.NdbTag("name", {
        description: "this is desc ok",
        entityType: "DATABASE",
        required: true,
    });
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    name = nutanix.NdbTag("name",
        description="this is desc ok",
        entity_type="DATABASE",
        required=True)
    
    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.NewNdbTag(ctx, "name", &nutanix.NdbTagArgs{
    			Description: pulumi.String("this is desc ok"),
    			EntityType:  pulumi.String("DATABASE"),
    			Required:    pulumi.Bool(true),
    		})
    		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 name = new Nutanix.NdbTag("name", new()
        {
            Description = "this is desc ok",
            EntityType = "DATABASE",
            Required = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.NdbTag;
    import com.pulumi.nutanix.NdbTagArgs;
    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 name = new NdbTag("name", NdbTagArgs.builder()
                .description("this is desc ok")
                .entityType("DATABASE")
                .required(true)
                .build());
    
        }
    }
    
    resources:
      name:
        type: nutanix:NdbTag
        properties:
          description: this is desc ok
          entityType: DATABASE
          required: true
    

    resource to update tag with status

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pierskarsenbarg/nutanix";
    
    const name = new nutanix.NdbTag("name", {
        description: "this is desc ok",
        entityType: "DATABASE",
        required: true,
        status: "DEPRECATED",
    });
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    name = nutanix.NdbTag("name",
        description="this is desc ok",
        entity_type="DATABASE",
        required=True,
        status="DEPRECATED")
    
    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.NewNdbTag(ctx, "name", &nutanix.NdbTagArgs{
    			Description: pulumi.String("this is desc ok"),
    			EntityType:  pulumi.String("DATABASE"),
    			Required:    pulumi.Bool(true),
    			Status:      pulumi.String("DEPRECATED"),
    		})
    		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 name = new Nutanix.NdbTag("name", new()
        {
            Description = "this is desc ok",
            EntityType = "DATABASE",
            Required = true,
            Status = "DEPRECATED",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.NdbTag;
    import com.pulumi.nutanix.NdbTagArgs;
    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 name = new NdbTag("name", NdbTagArgs.builder()
                .description("this is desc ok")
                .entityType("DATABASE")
                .required(true)
                .status("DEPRECATED")
                .build());
    
        }
    }
    
    resources:
      name:
        type: nutanix:NdbTag
        properties:
          description: this is desc ok
          entityType: DATABASE
          required: true
          status: DEPRECATED
    

    Create NdbTag Resource

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

    Constructor syntax

    new NdbTag(name: string, args: NdbTagArgs, opts?: CustomResourceOptions);
    @overload
    def NdbTag(resource_name: str,
               args: NdbTagArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def NdbTag(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               entity_type: Optional[str] = None,
               description: Optional[str] = None,
               name: Optional[str] = None,
               required: Optional[bool] = None,
               status: Optional[str] = None)
    func NewNdbTag(ctx *Context, name string, args NdbTagArgs, opts ...ResourceOption) (*NdbTag, error)
    public NdbTag(string name, NdbTagArgs args, CustomResourceOptions? opts = null)
    public NdbTag(String name, NdbTagArgs args)
    public NdbTag(String name, NdbTagArgs args, CustomResourceOptions options)
    
    type: nutanix:NdbTag
    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 NdbTagArgs
    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 NdbTagArgs
    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 NdbTagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NdbTagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NdbTagArgs
    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 ndbTagResource = new Nutanix.NdbTag("ndbTagResource", new()
    {
        EntityType = "string",
        Description = "string",
        Name = "string",
        Required = false,
        Status = "string",
    });
    
    example, err := nutanix.NewNdbTag(ctx, "ndbTagResource", &nutanix.NdbTagArgs{
    	EntityType:  pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Required:    pulumi.Bool(false),
    	Status:      pulumi.String("string"),
    })
    
    var ndbTagResource = new NdbTag("ndbTagResource", NdbTagArgs.builder()
        .entityType("string")
        .description("string")
        .name("string")
        .required(false)
        .status("string")
        .build());
    
    ndb_tag_resource = nutanix.NdbTag("ndbTagResource",
        entity_type="string",
        description="string",
        name="string",
        required=False,
        status="string")
    
    const ndbTagResource = new nutanix.NdbTag("ndbTagResource", {
        entityType: "string",
        description: "string",
        name: "string",
        required: false,
        status: "string",
    });
    
    type: nutanix:NdbTag
    properties:
        description: string
        entityType: string
        name: string
        required: false
        status: string
    

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

    EntityType string
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    Description string
    description for the tag
    Name string
    name for the tag
    Required bool
    provide a tag value for entities.
    Status string
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    EntityType string
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    Description string
    description for the tag
    Name string
    name for the tag
    Required bool
    provide a tag value for entities.
    Status string
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    entityType String
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    description String
    description for the tag
    name String
    name for the tag
    required Boolean
    provide a tag value for entities.
    status String
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    entityType string
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    description string
    description for the tag
    name string
    name for the tag
    required boolean
    provide a tag value for entities.
    status string
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    entity_type str
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    description str
    description for the tag
    name str
    name for the tag
    required bool
    provide a tag value for entities.
    status str
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    entityType String
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    description String
    description for the tag
    name String
    name for the tag
    required Boolean
    provide a tag value for entities.
    status String
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]

    Outputs

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

    DateCreated string
    date created of the tag
    DateModified string
    modified date of tha tag
    Id string
    The provider-assigned unique ID for this managed resource.
    Owner string
    owner id of the tag
    Values int
    value for the tag
    DateCreated string
    date created of the tag
    DateModified string
    modified date of tha tag
    Id string
    The provider-assigned unique ID for this managed resource.
    Owner string
    owner id of the tag
    Values int
    value for the tag
    dateCreated String
    date created of the tag
    dateModified String
    modified date of tha tag
    id String
    The provider-assigned unique ID for this managed resource.
    owner String
    owner id of the tag
    values Integer
    value for the tag
    dateCreated string
    date created of the tag
    dateModified string
    modified date of tha tag
    id string
    The provider-assigned unique ID for this managed resource.
    owner string
    owner id of the tag
    values number
    value for the tag
    date_created str
    date created of the tag
    date_modified str
    modified date of tha tag
    id str
    The provider-assigned unique ID for this managed resource.
    owner str
    owner id of the tag
    values int
    value for the tag
    dateCreated String
    date created of the tag
    dateModified String
    modified date of tha tag
    id String
    The provider-assigned unique ID for this managed resource.
    owner String
    owner id of the tag
    values Number
    value for the tag

    Look up Existing NdbTag Resource

    Get an existing NdbTag 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?: NdbTagState, opts?: CustomResourceOptions): NdbTag
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            date_created: Optional[str] = None,
            date_modified: Optional[str] = None,
            description: Optional[str] = None,
            entity_type: Optional[str] = None,
            name: Optional[str] = None,
            owner: Optional[str] = None,
            required: Optional[bool] = None,
            status: Optional[str] = None,
            values: Optional[int] = None) -> NdbTag
    func GetNdbTag(ctx *Context, name string, id IDInput, state *NdbTagState, opts ...ResourceOption) (*NdbTag, error)
    public static NdbTag Get(string name, Input<string> id, NdbTagState? state, CustomResourceOptions? opts = null)
    public static NdbTag get(String name, Output<String> id, NdbTagState 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:
    DateCreated string
    date created of the tag
    DateModified string
    modified date of tha tag
    Description string
    description for the tag
    EntityType string
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    Name string
    name for the tag
    Owner string
    owner id of the tag
    Required bool
    provide a tag value for entities.
    Status string
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    Values int
    value for the tag
    DateCreated string
    date created of the tag
    DateModified string
    modified date of tha tag
    Description string
    description for the tag
    EntityType string
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    Name string
    name for the tag
    Owner string
    owner id of the tag
    Required bool
    provide a tag value for entities.
    Status string
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    Values int
    value for the tag
    dateCreated String
    date created of the tag
    dateModified String
    modified date of tha tag
    description String
    description for the tag
    entityType String
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    name String
    name for the tag
    owner String
    owner id of the tag
    required Boolean
    provide a tag value for entities.
    status String
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    values Integer
    value for the tag
    dateCreated string
    date created of the tag
    dateModified string
    modified date of tha tag
    description string
    description for the tag
    entityType string
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    name string
    name for the tag
    owner string
    owner id of the tag
    required boolean
    provide a tag value for entities.
    status string
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    values number
    value for the tag
    date_created str
    date created of the tag
    date_modified str
    modified date of tha tag
    description str
    description for the tag
    entity_type str
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    name str
    name for the tag
    owner str
    owner id of the tag
    required bool
    provide a tag value for entities.
    status str
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    values int
    value for the tag
    dateCreated String
    date created of the tag
    dateModified String
    modified date of tha tag
    description String
    description for the tag
    entityType String
    entity for the tag to be associated with. Supported values [ DATABASE, TIME_MACHINE, CLONE, DATABASE_SERVER ].
    name String
    name for the tag
    owner String
    owner id of the tag
    required Boolean
    provide a tag value for entities.
    status String
    Status of the tag. Supported values are [ ENABLED, DEPRECATED ]
    values Number
    value for the tag

    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.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg