Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Impart Security
  3. API Docs
  4. Label
Impart Security v0.8.0 published on Monday, Nov 11, 2024 by Impart Security
impart-security/pulumi-impart

impart.Label

Explore with Pulumi AI

impart logo
Impart Security v0.8.0 published on Monday, Nov 11, 2024 by Impart Security
impart-security/pulumi-impart

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as impart from "@impart-security/pulumi-impart";

// Create a new label
const example = new impart.Label("example", {
    color: "red",
    description: "example label",
    displayName: "Example",
    slug: "example",
});

    import pulumi
import pulumi_impart as impart

# Create a new label
example = impart.Label("example",
    color="red",
    description="example label",
    display_name="Example",
    slug="example")

    package main

import (
	"github.com/impart-security/pulumi-impart/sdk/go/impart"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new label
		_, err := impart.NewLabel(ctx, "example", &impart.LabelArgs{
			Color:       pulumi.String("red"),
			Description: pulumi.String("example label"),
			DisplayName: pulumi.String("Example"),
			Slug:        pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Create a new label
    var example = new Impart.Label("example", new()
    {
        Color = "red",
        Description = "example label",
        DisplayName = "Example",
        Slug = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.impart.Label;
import com.pulumi.impart.LabelArgs;
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) {
        // Create a new label
        var example = new Label("example", LabelArgs.builder()
            .color("red")
            .description("example label")
            .displayName("Example")
            .slug("example")
            .build());

    }
}

    resources:
  # Create a new label
  example:
    type: impart:Label
    properties:
      color: red
      description: example label
      displayName: Example
      slug: example

    Create Label Resource

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

    Constructor syntax

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

@overload
def Label(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          slug: Optional[str] = None,
          color: Optional[str] = None,
          description: Optional[str] = None,
          display_name: Optional[str] = None)
    func NewLabel(ctx *Context, name string, args LabelArgs, opts ...ResourceOption) (*Label, error)
    public Label(string name, LabelArgs args, CustomResourceOptions? opts = null)
    public Label(String name, LabelArgs args)
public Label(String name, LabelArgs args, CustomResourceOptions options)

    type: impart:Label
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 LabelArgs
    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 LabelArgs
    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 LabelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LabelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LabelArgs
    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 labelResource = new Impart.Label("labelResource", new()
{
    Slug = "string",
    Color = "string",
    Description = "string",
    DisplayName = "string",
});

    example, err := impart.NewLabel(ctx, "labelResource", &impart.LabelArgs{
	Slug:        pulumi.String("string"),
	Color:       pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
})

    var labelResource = new Label("labelResource", LabelArgs.builder()
    .slug("string")
    .color("string")
    .description("string")
    .displayName("string")
    .build());

    label_resource = impart.Label("labelResource",
    slug="string",
    color="string",
    description="string",
    display_name="string")

    const labelResource = new impart.Label("labelResource", {
    slug: "string",
    color: "string",
    description: "string",
    displayName: "string",
});

    type: impart:Label
properties:
    color: string
    description: string
    displayName: string
    slug: string

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

    Slug string
    Slug of the label.
    Color string
    The color of the label.
    Description string
    The description of the label.
    DisplayName string
    The display name of the label.
    Slug string
    Slug of the label.
    Color string
    The color of the label.
    Description string
    The description of the label.
    DisplayName string
    The display name of the label.
    slug String
    Slug of the label.
    color String
    The color of the label.
    description String
    The description of the label.
    displayName String
    The display name of the label.
    slug string
    Slug of the label.
    color string
    The color of the label.
    description string
    The description of the label.
    displayName string
    The display name of the label.
    slug str
    Slug of the label.
    color str
    The color of the label.
    description str
    The description of the label.
    display_name str
    The display name of the label.
    slug String
    Slug of the label.
    color String
    The color of the label.
    description String
    The description of the label.
    displayName String
    The display name of the label.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Label 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 Label Resource

    Get an existing Label 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?: LabelState, opts?: CustomResourceOptions): Label
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        slug: Optional[str] = None) -> Label
    func GetLabel(ctx *Context, name string, id IDInput, state *LabelState, opts ...ResourceOption) (*Label, error)
    public static Label Get(string name, Input<string> id, LabelState? state, CustomResourceOptions? opts = null)
    public static Label get(String name, Output<String> id, LabelState 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:
    Color string
    The color of the label.
    Description string
    The description of the label.
    DisplayName string
    The display name of the label.
    Slug string
    Slug of the label.
    Color string
    The color of the label.
    Description string
    The description of the label.
    DisplayName string
    The display name of the label.
    Slug string
    Slug of the label.
    color String
    The color of the label.
    description String
    The description of the label.
    displayName String
    The display name of the label.
    slug String
    Slug of the label.
    color string
    The color of the label.
    description string
    The description of the label.
    displayName string
    The display name of the label.
    slug string
    Slug of the label.
    color str
    The color of the label.
    description str
    The description of the label.
    display_name str
    The display name of the label.
    slug str
    Slug of the label.
    color String
    The color of the label.
    description String
    The description of the label.
    displayName String
    The display name of the label.
    slug String
    Slug of the label.

    Package Details

    Repository
    impart impart-security/pulumi-impart
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the impart Terraform Provider.
    impart logo
    Impart Security v0.8.0 published on Monday, Nov 11, 2024 by Impart Security
    impart-security/pulumi-impart