Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Hsdp Provider
  3. API Docs
  4. CdlLabelDefinition
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

hsdp.CdlLabelDefinition

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
philips-software/terraform-provider-hsdp

    Manages HSDP Clinical Data Lake (CDL) Label Definitions.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as hsdp from "@pulumi/hsdp";

const labeldef1 = new hsdp.CdlLabelDefinition("labeldef1", {
    cdlEndpoint: "https://cicd-datalake.cloud.pcftest.com/store/cdl/1f5be763-f896-4883-80fa-5593cd69556d",
    description: "TF create desc",
    labelDefName: "TF create Test4",
    labelName: "videoQualityTF10",
    labelScope: "DataObject.DICOM",
    labels: [
        "good",
        "bad",
        "acceptable",
        "something",
        "something1",
    ],
    studyId: "a1467792-ef81-11eb-8ac2-477a9e3b09aa",
    type: "cdl/video-classification",
});

    import pulumi
import pulumi_hsdp as hsdp

labeldef1 = hsdp.CdlLabelDefinition("labeldef1",
    cdl_endpoint="https://cicd-datalake.cloud.pcftest.com/store/cdl/1f5be763-f896-4883-80fa-5593cd69556d",
    description="TF create desc",
    label_def_name="TF create Test4",
    label_name="videoQualityTF10",
    label_scope="DataObject.DICOM",
    labels=[
        "good",
        "bad",
        "acceptable",
        "something",
        "something1",
    ],
    study_id="a1467792-ef81-11eb-8ac2-477a9e3b09aa",
    type="cdl/video-classification")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hsdp.NewCdlLabelDefinition(ctx, "labeldef1", &hsdp.CdlLabelDefinitionArgs{
			CdlEndpoint:  pulumi.String("https://cicd-datalake.cloud.pcftest.com/store/cdl/1f5be763-f896-4883-80fa-5593cd69556d"),
			Description:  pulumi.String("TF create desc"),
			LabelDefName: pulumi.String("TF create Test4"),
			LabelName:    pulumi.String("videoQualityTF10"),
			LabelScope:   pulumi.String("DataObject.DICOM"),
			Labels: pulumi.StringArray{
				pulumi.String("good"),
				pulumi.String("bad"),
				pulumi.String("acceptable"),
				pulumi.String("something"),
				pulumi.String("something1"),
			},
			StudyId: pulumi.String("a1467792-ef81-11eb-8ac2-477a9e3b09aa"),
			Type:    pulumi.String("cdl/video-classification"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var labeldef1 = new Hsdp.CdlLabelDefinition("labeldef1", new()
    {
        CdlEndpoint = "https://cicd-datalake.cloud.pcftest.com/store/cdl/1f5be763-f896-4883-80fa-5593cd69556d",
        Description = "TF create desc",
        LabelDefName = "TF create Test4",
        LabelName = "videoQualityTF10",
        LabelScope = "DataObject.DICOM",
        Labels = new[]
        {
            "good",
            "bad",
            "acceptable",
            "something",
            "something1",
        },
        StudyId = "a1467792-ef81-11eb-8ac2-477a9e3b09aa",
        Type = "cdl/video-classification",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hsdp.CdlLabelDefinition;
import com.pulumi.hsdp.CdlLabelDefinitionArgs;
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 labeldef1 = new CdlLabelDefinition("labeldef1", CdlLabelDefinitionArgs.builder()
            .cdlEndpoint("https://cicd-datalake.cloud.pcftest.com/store/cdl/1f5be763-f896-4883-80fa-5593cd69556d")
            .description("TF create desc")
            .labelDefName("TF create Test4")
            .labelName("videoQualityTF10")
            .labelScope("DataObject.DICOM")
            .labels(            
                "good",
                "bad",
                "acceptable",
                "something",
                "something1")
            .studyId("a1467792-ef81-11eb-8ac2-477a9e3b09aa")
            .type("cdl/video-classification")
            .build());

    }
}

    resources:
  labeldef1:
    type: hsdp:CdlLabelDefinition
    properties:
      cdlEndpoint: https://cicd-datalake.cloud.pcftest.com/store/cdl/1f5be763-f896-4883-80fa-5593cd69556d
      description: TF create desc
      labelDefName: TF create Test4
      labelName: videoQualityTF10
      labelScope: DataObject.DICOM
      labels:
        - good
        - bad
        - acceptable
        - something
        - something1
      studyId: a1467792-ef81-11eb-8ac2-477a9e3b09aa
      type: cdl/video-classification

    Create CdlLabelDefinition Resource

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

    Constructor syntax

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

@overload
def CdlLabelDefinition(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cdl_endpoint: Optional[str] = None,
                       label_def_name: Optional[str] = None,
                       label_name: Optional[str] = None,
                       label_scope: Optional[str] = None,
                       labels: Optional[Sequence[str]] = None,
                       study_id: Optional[str] = None,
                       type: Optional[str] = None,
                       cdl_label_definition_id: Optional[str] = None,
                       description: Optional[str] = None)
    func NewCdlLabelDefinition(ctx *Context, name string, args CdlLabelDefinitionArgs, opts ...ResourceOption) (*CdlLabelDefinition, error)
    public CdlLabelDefinition(string name, CdlLabelDefinitionArgs args, CustomResourceOptions? opts = null)
    public CdlLabelDefinition(String name, CdlLabelDefinitionArgs args)
public CdlLabelDefinition(String name, CdlLabelDefinitionArgs args, CustomResourceOptions options)

    type: hsdp:CdlLabelDefinition
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 CdlLabelDefinitionArgs
    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 CdlLabelDefinitionArgs
    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 CdlLabelDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CdlLabelDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CdlLabelDefinitionArgs
    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 cdlLabelDefinitionResource = new Hsdp.CdlLabelDefinition("cdlLabelDefinitionResource", new()
{
    CdlEndpoint = "string",
    LabelDefName = "string",
    LabelName = "string",
    LabelScope = "string",
    Labels = new[]
    {
        "string",
    },
    StudyId = "string",
    Type = "string",
    CdlLabelDefinitionId = "string",
    Description = "string",
});

    example, err := hsdp.NewCdlLabelDefinition(ctx, "cdlLabelDefinitionResource", &hsdp.CdlLabelDefinitionArgs{
	CdlEndpoint:  pulumi.String("string"),
	LabelDefName: pulumi.String("string"),
	LabelName:    pulumi.String("string"),
	LabelScope:   pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	StudyId:              pulumi.String("string"),
	Type:                 pulumi.String("string"),
	CdlLabelDefinitionId: pulumi.String("string"),
	Description:          pulumi.String("string"),
})

    var cdlLabelDefinitionResource = new CdlLabelDefinition("cdlLabelDefinitionResource", CdlLabelDefinitionArgs.builder()
    .cdlEndpoint("string")
    .labelDefName("string")
    .labelName("string")
    .labelScope("string")
    .labels("string")
    .studyId("string")
    .type("string")
    .cdlLabelDefinitionId("string")
    .description("string")
    .build());

    cdl_label_definition_resource = hsdp.CdlLabelDefinition("cdlLabelDefinitionResource",
    cdl_endpoint="string",
    label_def_name="string",
    label_name="string",
    label_scope="string",
    labels=["string"],
    study_id="string",
    type="string",
    cdl_label_definition_id="string",
    description="string")

    const cdlLabelDefinitionResource = new hsdp.CdlLabelDefinition("cdlLabelDefinitionResource", {
    cdlEndpoint: "string",
    labelDefName: "string",
    labelName: "string",
    labelScope: "string",
    labels: ["string"],
    studyId: "string",
    type: "string",
    cdlLabelDefinitionId: "string",
    description: "string",
});

    type: hsdp:CdlLabelDefinition
properties:
    cdlEndpoint: string
    cdlLabelDefinitionId: string
    description: string
    labelDefName: string
    labelName: string
    labelScope: string
    labels:
        - string
    studyId: string
    type: string

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

    CdlEndpoint string
    The CDL instance endpoint to query
    LabelDefName string
    Name of the label definition
    LabelName string
    The label name
    LabelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    Labels List<string>
    Use this parameter to specify your labels, or classes. Add one label for each class.
    StudyId string
    The research study id under which label definition has to be created
    Type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    CdlLabelDefinitionId string
    The GUID of the label definition
    Description string
    Description of label definition
    CdlEndpoint string
    The CDL instance endpoint to query
    LabelDefName string
    Name of the label definition
    LabelName string
    The label name
    LabelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    Labels []string
    Use this parameter to specify your labels, or classes. Add one label for each class.
    StudyId string
    The research study id under which label definition has to be created
    Type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    CdlLabelDefinitionId string
    The GUID of the label definition
    Description string
    Description of label definition
    cdlEndpoint String
    The CDL instance endpoint to query
    labelDefName String
    Name of the label definition
    labelName String
    The label name
    labelScope String
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels List<String>
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId String
    The research study id under which label definition has to be created
    type String
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlLabelDefinitionId String
    The GUID of the label definition
    description String
    Description of label definition
    cdlEndpoint string
    The CDL instance endpoint to query
    labelDefName string
    Name of the label definition
    labelName string
    The label name
    labelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels string[]
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId string
    The research study id under which label definition has to be created
    type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlLabelDefinitionId string
    The GUID of the label definition
    description string
    Description of label definition
    cdl_endpoint str
    The CDL instance endpoint to query
    label_def_name str
    Name of the label definition
    label_name str
    The label name
    label_scope str
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels Sequence[str]
    Use this parameter to specify your labels, or classes. Add one label for each class.
    study_id str
    The research study id under which label definition has to be created
    type str
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdl_label_definition_id str
    The GUID of the label definition
    description str
    Description of label definition
    cdlEndpoint String
    The CDL instance endpoint to query
    labelDefName String
    Name of the label definition
    labelName String
    The label name
    labelScope String
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels List<String>
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId String
    The research study id under which label definition has to be created
    type String
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlLabelDefinitionId String
    The GUID of the label definition
    description String
    Description of label definition

    Outputs

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

    CreatedBy string
    User who created the label definition
    CreatedOn string
    Timestamp the label definition was created
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedBy string
    User who created the label definition
    CreatedOn string
    Timestamp the label definition was created
    Id string
    The provider-assigned unique ID for this managed resource.
    createdBy String
    User who created the label definition
    createdOn String
    Timestamp the label definition was created
    id String
    The provider-assigned unique ID for this managed resource.
    createdBy string
    User who created the label definition
    createdOn string
    Timestamp the label definition was created
    id string
    The provider-assigned unique ID for this managed resource.
    created_by str
    User who created the label definition
    created_on str
    Timestamp the label definition was created
    id str
    The provider-assigned unique ID for this managed resource.
    createdBy String
    User who created the label definition
    createdOn String
    Timestamp the label definition was created
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CdlLabelDefinition Resource

    Get an existing CdlLabelDefinition 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?: CdlLabelDefinitionState, opts?: CustomResourceOptions): CdlLabelDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cdl_endpoint: Optional[str] = None,
        cdl_label_definition_id: Optional[str] = None,
        created_by: Optional[str] = None,
        created_on: Optional[str] = None,
        description: Optional[str] = None,
        label_def_name: Optional[str] = None,
        label_name: Optional[str] = None,
        label_scope: Optional[str] = None,
        labels: Optional[Sequence[str]] = None,
        study_id: Optional[str] = None,
        type: Optional[str] = None) -> CdlLabelDefinition
    func GetCdlLabelDefinition(ctx *Context, name string, id IDInput, state *CdlLabelDefinitionState, opts ...ResourceOption) (*CdlLabelDefinition, error)
    public static CdlLabelDefinition Get(string name, Input<string> id, CdlLabelDefinitionState? state, CustomResourceOptions? opts = null)
    public static CdlLabelDefinition get(String name, Output<String> id, CdlLabelDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:CdlLabelDefinition    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:
    CdlEndpoint string
    The CDL instance endpoint to query
    CdlLabelDefinitionId string
    The GUID of the label definition
    CreatedBy string
    User who created the label definition
    CreatedOn string
    Timestamp the label definition was created
    Description string
    Description of label definition
    LabelDefName string
    Name of the label definition
    LabelName string
    The label name
    LabelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    Labels List<string>
    Use this parameter to specify your labels, or classes. Add one label for each class.
    StudyId string
    The research study id under which label definition has to be created
    Type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    CdlEndpoint string
    The CDL instance endpoint to query
    CdlLabelDefinitionId string
    The GUID of the label definition
    CreatedBy string
    User who created the label definition
    CreatedOn string
    Timestamp the label definition was created
    Description string
    Description of label definition
    LabelDefName string
    Name of the label definition
    LabelName string
    The label name
    LabelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    Labels []string
    Use this parameter to specify your labels, or classes. Add one label for each class.
    StudyId string
    The research study id under which label definition has to be created
    Type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlEndpoint String
    The CDL instance endpoint to query
    cdlLabelDefinitionId String
    The GUID of the label definition
    createdBy String
    User who created the label definition
    createdOn String
    Timestamp the label definition was created
    description String
    Description of label definition
    labelDefName String
    Name of the label definition
    labelName String
    The label name
    labelScope String
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels List<String>
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId String
    The research study id under which label definition has to be created
    type String
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlEndpoint string
    The CDL instance endpoint to query
    cdlLabelDefinitionId string
    The GUID of the label definition
    createdBy string
    User who created the label definition
    createdOn string
    Timestamp the label definition was created
    description string
    Description of label definition
    labelDefName string
    Name of the label definition
    labelName string
    The label name
    labelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels string[]
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId string
    The research study id under which label definition has to be created
    type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdl_endpoint str
    The CDL instance endpoint to query
    cdl_label_definition_id str
    The GUID of the label definition
    created_by str
    User who created the label definition
    created_on str
    Timestamp the label definition was created
    description str
    Description of label definition
    label_def_name str
    Name of the label definition
    label_name str
    The label name
    label_scope str
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels Sequence[str]
    Use this parameter to specify your labels, or classes. Add one label for each class.
    study_id str
    The research study id under which label definition has to be created
    type str
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlEndpoint String
    The CDL instance endpoint to query
    cdlLabelDefinitionId String
    The GUID of the label definition
    createdBy String
    User who created the label definition
    createdOn String
    Timestamp the label definition was created
    description String
    Description of label definition
    labelDefName String
    Name of the label definition
    labelName String
    The label name
    labelScope String
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels List<String>
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId String
    The research study id under which label definition has to be created
    type String
    Use this parameter to define the label type. Supported Values : cdl/video-classification

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software
    philips-software/terraform-provider-hsdp