1. Packages
  2. Formal Provider
  3. API Docs
  4. DataLabel
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

formal.DataLabel

Explore with Pulumi AI

formal logo
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal

    Registering a Data Label with Formal.

    Create DataLabel Resource

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

    Constructor syntax

    new DataLabel(name: string, args: DataLabelArgs, opts?: CustomResourceOptions);
    @overload
    def DataLabel(resource_name: str,
                  args: DataLabelArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataLabel(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  classifier_data: Optional[str] = None,
                  classifier_type: Optional[str] = None,
                  name: Optional[str] = None)
    func NewDataLabel(ctx *Context, name string, args DataLabelArgs, opts ...ResourceOption) (*DataLabel, error)
    public DataLabel(string name, DataLabelArgs args, CustomResourceOptions? opts = null)
    public DataLabel(String name, DataLabelArgs args)
    public DataLabel(String name, DataLabelArgs args, CustomResourceOptions options)
    
    type: formal:DataLabel
    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 DataLabelArgs
    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 DataLabelArgs
    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 DataLabelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataLabelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataLabelArgs
    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 dataLabelResource = new Pulumi.DataLabel("dataLabelResource", new()
    {
        ClassifierData = "string",
        ClassifierType = "string",
        Name = "string",
    });
    
    example, err := formal.NewDataLabel(ctx, "dataLabelResource", &formal.DataLabelArgs{
    	ClassifierData: pulumi.String("string"),
    	ClassifierType: pulumi.String("string"),
    	Name:           pulumi.String("string"),
    })
    
    var dataLabelResource = new DataLabel("dataLabelResource", DataLabelArgs.builder()
        .classifierData("string")
        .classifierType("string")
        .name("string")
        .build());
    
    data_label_resource = formal.DataLabel("dataLabelResource",
        classifier_data="string",
        classifier_type="string",
        name="string")
    
    const dataLabelResource = new formal.DataLabel("dataLabelResource", {
        classifierData: "string",
        classifierType: "string",
        name: "string",
    });
    
    type: formal:DataLabel
    properties:
        classifierData: string
        classifierType: string
        name: string
    

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

    ClassifierData string
    Data for the classifier (pattern for regex or label name for prompt).
    ClassifierType string
    Type of classifier for the data label (regex or prompt)
    Name string
    Friendly name for this data label.
    ClassifierData string
    Data for the classifier (pattern for regex or label name for prompt).
    ClassifierType string
    Type of classifier for the data label (regex or prompt)
    Name string
    Friendly name for this data label.
    classifierData String
    Data for the classifier (pattern for regex or label name for prompt).
    classifierType String
    Type of classifier for the data label (regex or prompt)
    name String
    Friendly name for this data label.
    classifierData string
    Data for the classifier (pattern for regex or label name for prompt).
    classifierType string
    Type of classifier for the data label (regex or prompt)
    name string
    Friendly name for this data label.
    classifier_data str
    Data for the classifier (pattern for regex or label name for prompt).
    classifier_type str
    Type of classifier for the data label (regex or prompt)
    name str
    Friendly name for this data label.
    classifierData String
    Data for the classifier (pattern for regex or label name for prompt).
    classifierType String
    Type of classifier for the data label (regex or prompt)
    name String
    Friendly name for this data label.

    Outputs

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

    Get an existing DataLabel 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?: DataLabelState, opts?: CustomResourceOptions): DataLabel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            classifier_data: Optional[str] = None,
            classifier_type: Optional[str] = None,
            name: Optional[str] = None) -> DataLabel
    func GetDataLabel(ctx *Context, name string, id IDInput, state *DataLabelState, opts ...ResourceOption) (*DataLabel, error)
    public static DataLabel Get(string name, Input<string> id, DataLabelState? state, CustomResourceOptions? opts = null)
    public static DataLabel get(String name, Output<String> id, DataLabelState state, CustomResourceOptions options)
    resources:  _:    type: formal:DataLabel    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:
    ClassifierData string
    Data for the classifier (pattern for regex or label name for prompt).
    ClassifierType string
    Type of classifier for the data label (regex or prompt)
    Name string
    Friendly name for this data label.
    ClassifierData string
    Data for the classifier (pattern for regex or label name for prompt).
    ClassifierType string
    Type of classifier for the data label (regex or prompt)
    Name string
    Friendly name for this data label.
    classifierData String
    Data for the classifier (pattern for regex or label name for prompt).
    classifierType String
    Type of classifier for the data label (regex or prompt)
    name String
    Friendly name for this data label.
    classifierData string
    Data for the classifier (pattern for regex or label name for prompt).
    classifierType string
    Type of classifier for the data label (regex or prompt)
    name string
    Friendly name for this data label.
    classifier_data str
    Data for the classifier (pattern for regex or label name for prompt).
    classifier_type str
    Type of classifier for the data label (regex or prompt)
    name str
    Friendly name for this data label.
    classifierData String
    Data for the classifier (pattern for regex or label name for prompt).
    classifierType String
    Type of classifier for the data label (regex or prompt)
    name String
    Friendly name for this data label.

    Package Details

    Repository
    formal formalco/pulumi-formal
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the formal Terraform Provider.
    formal logo
    Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal