1. Packages
  2. Hsdp Provider
  3. API Docs
  4. CdlResearchStudy
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.CdlResearchStudy

Explore with Pulumi AI

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

    Provides a resource for managing HSDP Clinical Data Lake (CDL) research studies. A Research Study is a concept in CDL used to organize the data within Data Lake. It acts as a container of your clinical trial. Data will be completely isolated, an authorization model can be enforced per Research Study.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const studyA = new hsdp.CdlResearchStudy("studyA", {
        cdlEndpoint: data.cdl_instance.cicd.endpoint,
        title: "Study A",
        description: "Example study A",
        studyOwner: _var.study_owner_id,
        endsAt: _var.ends_at,
        dataScientists: [{
            userId: data.hsdp_iam_user.scientist.id,
            email: data.hsdp_iam_user.scientist.email_address,
        }],
        uploaders: [
            {
                userId: data.hsdp_iam_user.uploaderA.id,
                email: data.hsdp_iam_user.uploaderA.email_address,
            },
            {
                userId: data.hsdp_iam_user.uploaderB.id,
                email: data.hsdp_iam_user.uploaderB.email_address,
            },
        ],
        monitors: [{
            userId: data.hsdp_iam_user.monitor.id,
            email: data.hsdp_iam_user.monitor.email_address,
        }],
        studyManagers: [{
            userId: data.hsdp_iam_user.study_manager.id,
            email: data.hsdp_iam_user.study_manager.email_address,
        }],
        dataProtectedFromDeletion: false,
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    study_a = hsdp.CdlResearchStudy("studyA",
        cdl_endpoint=data["cdl_instance"]["cicd"]["endpoint"],
        title="Study A",
        description="Example study A",
        study_owner=var["study_owner_id"],
        ends_at=var["ends_at"],
        data_scientists=[{
            "user_id": data["hsdp_iam_user"]["scientist"]["id"],
            "email": data["hsdp_iam_user"]["scientist"]["email_address"],
        }],
        uploaders=[
            {
                "user_id": data["hsdp_iam_user"]["uploaderA"]["id"],
                "email": data["hsdp_iam_user"]["uploaderA"]["email_address"],
            },
            {
                "user_id": data["hsdp_iam_user"]["uploaderB"]["id"],
                "email": data["hsdp_iam_user"]["uploaderB"]["email_address"],
            },
        ],
        monitors=[{
            "user_id": data["hsdp_iam_user"]["monitor"]["id"],
            "email": data["hsdp_iam_user"]["monitor"]["email_address"],
        }],
        study_managers=[{
            "user_id": data["hsdp_iam_user"]["study_manager"]["id"],
            "email": data["hsdp_iam_user"]["study_manager"]["email_address"],
        }],
        data_protected_from_deletion=False)
    
    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.NewCdlResearchStudy(ctx, "studyA", &hsdp.CdlResearchStudyArgs{
    			CdlEndpoint: pulumi.Any(data.Cdl_instance.Cicd.Endpoint),
    			Title:       pulumi.String("Study A"),
    			Description: pulumi.String("Example study A"),
    			StudyOwner:  pulumi.Any(_var.Study_owner_id),
    			EndsAt:      pulumi.Any(_var.Ends_at),
    			DataScientists: hsdp.CdlResearchStudyDataScientistArray{
    				&hsdp.CdlResearchStudyDataScientistArgs{
    					UserId: pulumi.Any(data.Hsdp_iam_user.Scientist.Id),
    					Email:  pulumi.Any(data.Hsdp_iam_user.Scientist.Email_address),
    				},
    			},
    			Uploaders: hsdp.CdlResearchStudyUploaderArray{
    				&hsdp.CdlResearchStudyUploaderArgs{
    					UserId: pulumi.Any(data.Hsdp_iam_user.UploaderA.Id),
    					Email:  pulumi.Any(data.Hsdp_iam_user.UploaderA.Email_address),
    				},
    				&hsdp.CdlResearchStudyUploaderArgs{
    					UserId: pulumi.Any(data.Hsdp_iam_user.UploaderB.Id),
    					Email:  pulumi.Any(data.Hsdp_iam_user.UploaderB.Email_address),
    				},
    			},
    			Monitors: hsdp.CdlResearchStudyMonitorArray{
    				&hsdp.CdlResearchStudyMonitorArgs{
    					UserId: pulumi.Any(data.Hsdp_iam_user.Monitor.Id),
    					Email:  pulumi.Any(data.Hsdp_iam_user.Monitor.Email_address),
    				},
    			},
    			StudyManagers: hsdp.CdlResearchStudyStudyManagerArray{
    				&hsdp.CdlResearchStudyStudyManagerArgs{
    					UserId: pulumi.Any(data.Hsdp_iam_user.Study_manager.Id),
    					Email:  pulumi.Any(data.Hsdp_iam_user.Study_manager.Email_address),
    				},
    			},
    			DataProtectedFromDeletion: pulumi.Bool(false),
    		})
    		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 studyA = new Hsdp.CdlResearchStudy("studyA", new()
        {
            CdlEndpoint = data.Cdl_instance.Cicd.Endpoint,
            Title = "Study A",
            Description = "Example study A",
            StudyOwner = @var.Study_owner_id,
            EndsAt = @var.Ends_at,
            DataScientists = new[]
            {
                new Hsdp.Inputs.CdlResearchStudyDataScientistArgs
                {
                    UserId = data.Hsdp_iam_user.Scientist.Id,
                    Email = data.Hsdp_iam_user.Scientist.Email_address,
                },
            },
            Uploaders = new[]
            {
                new Hsdp.Inputs.CdlResearchStudyUploaderArgs
                {
                    UserId = data.Hsdp_iam_user.UploaderA.Id,
                    Email = data.Hsdp_iam_user.UploaderA.Email_address,
                },
                new Hsdp.Inputs.CdlResearchStudyUploaderArgs
                {
                    UserId = data.Hsdp_iam_user.UploaderB.Id,
                    Email = data.Hsdp_iam_user.UploaderB.Email_address,
                },
            },
            Monitors = new[]
            {
                new Hsdp.Inputs.CdlResearchStudyMonitorArgs
                {
                    UserId = data.Hsdp_iam_user.Monitor.Id,
                    Email = data.Hsdp_iam_user.Monitor.Email_address,
                },
            },
            StudyManagers = new[]
            {
                new Hsdp.Inputs.CdlResearchStudyStudyManagerArgs
                {
                    UserId = data.Hsdp_iam_user.Study_manager.Id,
                    Email = data.Hsdp_iam_user.Study_manager.Email_address,
                },
            },
            DataProtectedFromDeletion = false,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.CdlResearchStudy;
    import com.pulumi.hsdp.CdlResearchStudyArgs;
    import com.pulumi.hsdp.inputs.CdlResearchStudyDataScientistArgs;
    import com.pulumi.hsdp.inputs.CdlResearchStudyUploaderArgs;
    import com.pulumi.hsdp.inputs.CdlResearchStudyMonitorArgs;
    import com.pulumi.hsdp.inputs.CdlResearchStudyStudyManagerArgs;
    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 studyA = new CdlResearchStudy("studyA", CdlResearchStudyArgs.builder()
                .cdlEndpoint(data.cdl_instance().cicd().endpoint())
                .title("Study A")
                .description("Example study A")
                .studyOwner(var_.study_owner_id())
                .endsAt(var_.ends_at())
                .dataScientists(CdlResearchStudyDataScientistArgs.builder()
                    .userId(data.hsdp_iam_user().scientist().id())
                    .email(data.hsdp_iam_user().scientist().email_address())
                    .build())
                .uploaders(            
                    CdlResearchStudyUploaderArgs.builder()
                        .userId(data.hsdp_iam_user().uploaderA().id())
                        .email(data.hsdp_iam_user().uploaderA().email_address())
                        .build(),
                    CdlResearchStudyUploaderArgs.builder()
                        .userId(data.hsdp_iam_user().uploaderB().id())
                        .email(data.hsdp_iam_user().uploaderB().email_address())
                        .build())
                .monitors(CdlResearchStudyMonitorArgs.builder()
                    .userId(data.hsdp_iam_user().monitor().id())
                    .email(data.hsdp_iam_user().monitor().email_address())
                    .build())
                .studyManagers(CdlResearchStudyStudyManagerArgs.builder()
                    .userId(data.hsdp_iam_user().study_manager().id())
                    .email(data.hsdp_iam_user().study_manager().email_address())
                    .build())
                .dataProtectedFromDeletion(false)
                .build());
    
        }
    }
    
    resources:
      studyA:
        type: hsdp:CdlResearchStudy
        properties:
          cdlEndpoint: ${data.cdl_instance.cicd.endpoint}
          title: Study A
          description: Example study A
          studyOwner: ${var.study_owner_id}
          endsAt: ${var.ends_at}
          dataScientists:
            - userId: ${data.hsdp_iam_user.scientist.id}
              email: ${data.hsdp_iam_user.scientist.email_address}
          uploaders:
            - userId: ${data.hsdp_iam_user.uploaderA.id}
              email: ${data.hsdp_iam_user.uploaderA.email_address}
            - userId: ${data.hsdp_iam_user.uploaderB.id}
              email: ${data.hsdp_iam_user.uploaderB.email_address}
          monitors:
            - userId: ${data.hsdp_iam_user.monitor.id}
              email: ${data.hsdp_iam_user.monitor.email_address}
          studyManagers:
            - userId: ${data.hsdp_iam_user.study_manager.id}
              email: ${data.hsdp_iam_user.study_manager.email_address}
          dataProtectedFromDeletion: false
    

    Create CdlResearchStudy Resource

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

    Constructor syntax

    new CdlResearchStudy(name: string, args: CdlResearchStudyArgs, opts?: CustomResourceOptions);
    @overload
    def CdlResearchStudy(resource_name: str,
                         args: CdlResearchStudyArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def CdlResearchStudy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         cdl_endpoint: Optional[str] = None,
                         study_owner: Optional[str] = None,
                         title: Optional[str] = None,
                         cdl_research_study_id: Optional[str] = None,
                         data_protected_from_deletion: Optional[bool] = None,
                         data_scientists: Optional[Sequence[CdlResearchStudyDataScientistArgs]] = None,
                         description: Optional[str] = None,
                         ends_at: Optional[str] = None,
                         monitors: Optional[Sequence[CdlResearchStudyMonitorArgs]] = None,
                         study_managers: Optional[Sequence[CdlResearchStudyStudyManagerArgs]] = None,
                         uploaders: Optional[Sequence[CdlResearchStudyUploaderArgs]] = None)
    func NewCdlResearchStudy(ctx *Context, name string, args CdlResearchStudyArgs, opts ...ResourceOption) (*CdlResearchStudy, error)
    public CdlResearchStudy(string name, CdlResearchStudyArgs args, CustomResourceOptions? opts = null)
    public CdlResearchStudy(String name, CdlResearchStudyArgs args)
    public CdlResearchStudy(String name, CdlResearchStudyArgs args, CustomResourceOptions options)
    
    type: hsdp:CdlResearchStudy
    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 CdlResearchStudyArgs
    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 CdlResearchStudyArgs
    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 CdlResearchStudyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CdlResearchStudyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CdlResearchStudyArgs
    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 cdlResearchStudyResource = new Hsdp.CdlResearchStudy("cdlResearchStudyResource", new()
    {
        CdlEndpoint = "string",
        StudyOwner = "string",
        Title = "string",
        CdlResearchStudyId = "string",
        DataProtectedFromDeletion = false,
        DataScientists = new[]
        {
            new Hsdp.Inputs.CdlResearchStudyDataScientistArgs
            {
                Email = "string",
                UserId = "string",
                InstituteId = "string",
            },
        },
        Description = "string",
        EndsAt = "string",
        Monitors = new[]
        {
            new Hsdp.Inputs.CdlResearchStudyMonitorArgs
            {
                Email = "string",
                UserId = "string",
                InstituteId = "string",
            },
        },
        StudyManagers = new[]
        {
            new Hsdp.Inputs.CdlResearchStudyStudyManagerArgs
            {
                Email = "string",
                UserId = "string",
                InstituteId = "string",
            },
        },
        Uploaders = new[]
        {
            new Hsdp.Inputs.CdlResearchStudyUploaderArgs
            {
                Email = "string",
                UserId = "string",
                InstituteId = "string",
            },
        },
    });
    
    example, err := hsdp.NewCdlResearchStudy(ctx, "cdlResearchStudyResource", &hsdp.CdlResearchStudyArgs{
    	CdlEndpoint:               pulumi.String("string"),
    	StudyOwner:                pulumi.String("string"),
    	Title:                     pulumi.String("string"),
    	CdlResearchStudyId:        pulumi.String("string"),
    	DataProtectedFromDeletion: pulumi.Bool(false),
    	DataScientists: hsdp.CdlResearchStudyDataScientistArray{
    		&hsdp.CdlResearchStudyDataScientistArgs{
    			Email:       pulumi.String("string"),
    			UserId:      pulumi.String("string"),
    			InstituteId: pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    	EndsAt:      pulumi.String("string"),
    	Monitors: hsdp.CdlResearchStudyMonitorArray{
    		&hsdp.CdlResearchStudyMonitorArgs{
    			Email:       pulumi.String("string"),
    			UserId:      pulumi.String("string"),
    			InstituteId: pulumi.String("string"),
    		},
    	},
    	StudyManagers: hsdp.CdlResearchStudyStudyManagerArray{
    		&hsdp.CdlResearchStudyStudyManagerArgs{
    			Email:       pulumi.String("string"),
    			UserId:      pulumi.String("string"),
    			InstituteId: pulumi.String("string"),
    		},
    	},
    	Uploaders: hsdp.CdlResearchStudyUploaderArray{
    		&hsdp.CdlResearchStudyUploaderArgs{
    			Email:       pulumi.String("string"),
    			UserId:      pulumi.String("string"),
    			InstituteId: pulumi.String("string"),
    		},
    	},
    })
    
    var cdlResearchStudyResource = new CdlResearchStudy("cdlResearchStudyResource", CdlResearchStudyArgs.builder()
        .cdlEndpoint("string")
        .studyOwner("string")
        .title("string")
        .cdlResearchStudyId("string")
        .dataProtectedFromDeletion(false)
        .dataScientists(CdlResearchStudyDataScientistArgs.builder()
            .email("string")
            .userId("string")
            .instituteId("string")
            .build())
        .description("string")
        .endsAt("string")
        .monitors(CdlResearchStudyMonitorArgs.builder()
            .email("string")
            .userId("string")
            .instituteId("string")
            .build())
        .studyManagers(CdlResearchStudyStudyManagerArgs.builder()
            .email("string")
            .userId("string")
            .instituteId("string")
            .build())
        .uploaders(CdlResearchStudyUploaderArgs.builder()
            .email("string")
            .userId("string")
            .instituteId("string")
            .build())
        .build());
    
    cdl_research_study_resource = hsdp.CdlResearchStudy("cdlResearchStudyResource",
        cdl_endpoint="string",
        study_owner="string",
        title="string",
        cdl_research_study_id="string",
        data_protected_from_deletion=False,
        data_scientists=[{
            "email": "string",
            "user_id": "string",
            "institute_id": "string",
        }],
        description="string",
        ends_at="string",
        monitors=[{
            "email": "string",
            "user_id": "string",
            "institute_id": "string",
        }],
        study_managers=[{
            "email": "string",
            "user_id": "string",
            "institute_id": "string",
        }],
        uploaders=[{
            "email": "string",
            "user_id": "string",
            "institute_id": "string",
        }])
    
    const cdlResearchStudyResource = new hsdp.CdlResearchStudy("cdlResearchStudyResource", {
        cdlEndpoint: "string",
        studyOwner: "string",
        title: "string",
        cdlResearchStudyId: "string",
        dataProtectedFromDeletion: false,
        dataScientists: [{
            email: "string",
            userId: "string",
            instituteId: "string",
        }],
        description: "string",
        endsAt: "string",
        monitors: [{
            email: "string",
            userId: "string",
            instituteId: "string",
        }],
        studyManagers: [{
            email: "string",
            userId: "string",
            instituteId: "string",
        }],
        uploaders: [{
            email: "string",
            userId: "string",
            instituteId: "string",
        }],
    });
    
    type: hsdp:CdlResearchStudy
    properties:
        cdlEndpoint: string
        cdlResearchStudyId: string
        dataProtectedFromDeletion: false
        dataScientists:
            - email: string
              instituteId: string
              userId: string
        description: string
        endsAt: string
        monitors:
            - email: string
              instituteId: string
              userId: string
        studyManagers:
            - email: string
              instituteId: string
              userId: string
        studyOwner: string
        title: string
        uploaders:
            - email: string
              instituteId: string
              userId: string
    

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

    CdlEndpoint string
    The CDL instance to query
    StudyOwner string
    The owner of the study
    Title string
    The name of the application
    CdlResearchStudyId string
    The GUID of the study
    DataProtectedFromDeletion bool
    Protects data from being deleted. Default is false
    DataScientists List<CdlResearchStudyDataScientist>
    A data scientist role definition for the study
    Description string
    The description of the application
    EndsAt string
    The end date of the study
    Monitors List<CdlResearchStudyMonitor>
    A monitor role definition for the study
    StudyManagers List<CdlResearchStudyStudyManager>
    An study manager role definition for the study
    Uploaders List<CdlResearchStudyUploader>
    An uploader role definition for the study
    CdlEndpoint string
    The CDL instance to query
    StudyOwner string
    The owner of the study
    Title string
    The name of the application
    CdlResearchStudyId string
    The GUID of the study
    DataProtectedFromDeletion bool
    Protects data from being deleted. Default is false
    DataScientists []CdlResearchStudyDataScientistArgs
    A data scientist role definition for the study
    Description string
    The description of the application
    EndsAt string
    The end date of the study
    Monitors []CdlResearchStudyMonitorArgs
    A monitor role definition for the study
    StudyManagers []CdlResearchStudyStudyManagerArgs
    An study manager role definition for the study
    Uploaders []CdlResearchStudyUploaderArgs
    An uploader role definition for the study
    cdlEndpoint String
    The CDL instance to query
    studyOwner String
    The owner of the study
    title String
    The name of the application
    cdlResearchStudyId String
    The GUID of the study
    dataProtectedFromDeletion Boolean
    Protects data from being deleted. Default is false
    dataScientists List<CdlResearchStudyDataScientist>
    A data scientist role definition for the study
    description String
    The description of the application
    endsAt String
    The end date of the study
    monitors List<CdlResearchStudyMonitor>
    A monitor role definition for the study
    studyManagers List<CdlResearchStudyStudyManager>
    An study manager role definition for the study
    uploaders List<CdlResearchStudyUploader>
    An uploader role definition for the study
    cdlEndpoint string
    The CDL instance to query
    studyOwner string
    The owner of the study
    title string
    The name of the application
    cdlResearchStudyId string
    The GUID of the study
    dataProtectedFromDeletion boolean
    Protects data from being deleted. Default is false
    dataScientists CdlResearchStudyDataScientist[]
    A data scientist role definition for the study
    description string
    The description of the application
    endsAt string
    The end date of the study
    monitors CdlResearchStudyMonitor[]
    A monitor role definition for the study
    studyManagers CdlResearchStudyStudyManager[]
    An study manager role definition for the study
    uploaders CdlResearchStudyUploader[]
    An uploader role definition for the study
    cdl_endpoint str
    The CDL instance to query
    study_owner str
    The owner of the study
    title str
    The name of the application
    cdl_research_study_id str
    The GUID of the study
    data_protected_from_deletion bool
    Protects data from being deleted. Default is false
    data_scientists Sequence[CdlResearchStudyDataScientistArgs]
    A data scientist role definition for the study
    description str
    The description of the application
    ends_at str
    The end date of the study
    monitors Sequence[CdlResearchStudyMonitorArgs]
    A monitor role definition for the study
    study_managers Sequence[CdlResearchStudyStudyManagerArgs]
    An study manager role definition for the study
    uploaders Sequence[CdlResearchStudyUploaderArgs]
    An uploader role definition for the study
    cdlEndpoint String
    The CDL instance to query
    studyOwner String
    The owner of the study
    title String
    The name of the application
    cdlResearchStudyId String
    The GUID of the study
    dataProtectedFromDeletion Boolean
    Protects data from being deleted. Default is false
    dataScientists List<Property Map>
    A data scientist role definition for the study
    description String
    The description of the application
    endsAt String
    The end date of the study
    monitors List<Property Map>
    A monitor role definition for the study
    studyManagers List<Property Map>
    An study manager role definition for the study
    uploaders List<Property Map>
    An uploader role definition for the study

    Outputs

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

    Get an existing CdlResearchStudy 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?: CdlResearchStudyState, opts?: CustomResourceOptions): CdlResearchStudy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cdl_endpoint: Optional[str] = None,
            cdl_research_study_id: Optional[str] = None,
            data_protected_from_deletion: Optional[bool] = None,
            data_scientists: Optional[Sequence[CdlResearchStudyDataScientistArgs]] = None,
            description: Optional[str] = None,
            ends_at: Optional[str] = None,
            monitors: Optional[Sequence[CdlResearchStudyMonitorArgs]] = None,
            study_managers: Optional[Sequence[CdlResearchStudyStudyManagerArgs]] = None,
            study_owner: Optional[str] = None,
            title: Optional[str] = None,
            uploaders: Optional[Sequence[CdlResearchStudyUploaderArgs]] = None) -> CdlResearchStudy
    func GetCdlResearchStudy(ctx *Context, name string, id IDInput, state *CdlResearchStudyState, opts ...ResourceOption) (*CdlResearchStudy, error)
    public static CdlResearchStudy Get(string name, Input<string> id, CdlResearchStudyState? state, CustomResourceOptions? opts = null)
    public static CdlResearchStudy get(String name, Output<String> id, CdlResearchStudyState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:CdlResearchStudy    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 to query
    CdlResearchStudyId string
    The GUID of the study
    DataProtectedFromDeletion bool
    Protects data from being deleted. Default is false
    DataScientists List<CdlResearchStudyDataScientist>
    A data scientist role definition for the study
    Description string
    The description of the application
    EndsAt string
    The end date of the study
    Monitors List<CdlResearchStudyMonitor>
    A monitor role definition for the study
    StudyManagers List<CdlResearchStudyStudyManager>
    An study manager role definition for the study
    StudyOwner string
    The owner of the study
    Title string
    The name of the application
    Uploaders List<CdlResearchStudyUploader>
    An uploader role definition for the study
    CdlEndpoint string
    The CDL instance to query
    CdlResearchStudyId string
    The GUID of the study
    DataProtectedFromDeletion bool
    Protects data from being deleted. Default is false
    DataScientists []CdlResearchStudyDataScientistArgs
    A data scientist role definition for the study
    Description string
    The description of the application
    EndsAt string
    The end date of the study
    Monitors []CdlResearchStudyMonitorArgs
    A monitor role definition for the study
    StudyManagers []CdlResearchStudyStudyManagerArgs
    An study manager role definition for the study
    StudyOwner string
    The owner of the study
    Title string
    The name of the application
    Uploaders []CdlResearchStudyUploaderArgs
    An uploader role definition for the study
    cdlEndpoint String
    The CDL instance to query
    cdlResearchStudyId String
    The GUID of the study
    dataProtectedFromDeletion Boolean
    Protects data from being deleted. Default is false
    dataScientists List<CdlResearchStudyDataScientist>
    A data scientist role definition for the study
    description String
    The description of the application
    endsAt String
    The end date of the study
    monitors List<CdlResearchStudyMonitor>
    A monitor role definition for the study
    studyManagers List<CdlResearchStudyStudyManager>
    An study manager role definition for the study
    studyOwner String
    The owner of the study
    title String
    The name of the application
    uploaders List<CdlResearchStudyUploader>
    An uploader role definition for the study
    cdlEndpoint string
    The CDL instance to query
    cdlResearchStudyId string
    The GUID of the study
    dataProtectedFromDeletion boolean
    Protects data from being deleted. Default is false
    dataScientists CdlResearchStudyDataScientist[]
    A data scientist role definition for the study
    description string
    The description of the application
    endsAt string
    The end date of the study
    monitors CdlResearchStudyMonitor[]
    A monitor role definition for the study
    studyManagers CdlResearchStudyStudyManager[]
    An study manager role definition for the study
    studyOwner string
    The owner of the study
    title string
    The name of the application
    uploaders CdlResearchStudyUploader[]
    An uploader role definition for the study
    cdl_endpoint str
    The CDL instance to query
    cdl_research_study_id str
    The GUID of the study
    data_protected_from_deletion bool
    Protects data from being deleted. Default is false
    data_scientists Sequence[CdlResearchStudyDataScientistArgs]
    A data scientist role definition for the study
    description str
    The description of the application
    ends_at str
    The end date of the study
    monitors Sequence[CdlResearchStudyMonitorArgs]
    A monitor role definition for the study
    study_managers Sequence[CdlResearchStudyStudyManagerArgs]
    An study manager role definition for the study
    study_owner str
    The owner of the study
    title str
    The name of the application
    uploaders Sequence[CdlResearchStudyUploaderArgs]
    An uploader role definition for the study
    cdlEndpoint String
    The CDL instance to query
    cdlResearchStudyId String
    The GUID of the study
    dataProtectedFromDeletion Boolean
    Protects data from being deleted. Default is false
    dataScientists List<Property Map>
    A data scientist role definition for the study
    description String
    The description of the application
    endsAt String
    The end date of the study
    monitors List<Property Map>
    A monitor role definition for the study
    studyManagers List<Property Map>
    An study manager role definition for the study
    studyOwner String
    The owner of the study
    title String
    The name of the application
    uploaders List<Property Map>
    An uploader role definition for the study

    Supporting Types

    CdlResearchStudyDataScientist, CdlResearchStudyDataScientistArgs

    Email string
    The email address for this data scientist (for display purposes)
    UserId string
    The IAM user ID of the data scientist
    InstituteId string
    The institute ID associated with this role
    Email string
    The email address for this data scientist (for display purposes)
    UserId string
    The IAM user ID of the data scientist
    InstituteId string
    The institute ID associated with this role
    email String
    The email address for this data scientist (for display purposes)
    userId String
    The IAM user ID of the data scientist
    instituteId String
    The institute ID associated with this role
    email string
    The email address for this data scientist (for display purposes)
    userId string
    The IAM user ID of the data scientist
    instituteId string
    The institute ID associated with this role
    email str
    The email address for this data scientist (for display purposes)
    user_id str
    The IAM user ID of the data scientist
    institute_id str
    The institute ID associated with this role
    email String
    The email address for this data scientist (for display purposes)
    userId String
    The IAM user ID of the data scientist
    instituteId String
    The institute ID associated with this role

    CdlResearchStudyMonitor, CdlResearchStudyMonitorArgs

    Email string
    The email address for this monitor (for display purposes)
    UserId string
    The IAM user ID of the monitor
    InstituteId string
    The institute ID associated with this role
    Email string
    The email address for this monitor (for display purposes)
    UserId string
    The IAM user ID of the monitor
    InstituteId string
    The institute ID associated with this role
    email String
    The email address for this monitor (for display purposes)
    userId String
    The IAM user ID of the monitor
    instituteId String
    The institute ID associated with this role
    email string
    The email address for this monitor (for display purposes)
    userId string
    The IAM user ID of the monitor
    instituteId string
    The institute ID associated with this role
    email str
    The email address for this monitor (for display purposes)
    user_id str
    The IAM user ID of the monitor
    institute_id str
    The institute ID associated with this role
    email String
    The email address for this monitor (for display purposes)
    userId String
    The IAM user ID of the monitor
    instituteId String
    The institute ID associated with this role

    CdlResearchStudyStudyManager, CdlResearchStudyStudyManagerArgs

    Email string
    The email address for this study manager (for display purposes)
    UserId string
    The IAM user ID of the study manager
    InstituteId string
    The institute ID associated with this role
    Email string
    The email address for this study manager (for display purposes)
    UserId string
    The IAM user ID of the study manager
    InstituteId string
    The institute ID associated with this role
    email String
    The email address for this study manager (for display purposes)
    userId String
    The IAM user ID of the study manager
    instituteId String
    The institute ID associated with this role
    email string
    The email address for this study manager (for display purposes)
    userId string
    The IAM user ID of the study manager
    instituteId string
    The institute ID associated with this role
    email str
    The email address for this study manager (for display purposes)
    user_id str
    The IAM user ID of the study manager
    institute_id str
    The institute ID associated with this role
    email String
    The email address for this study manager (for display purposes)
    userId String
    The IAM user ID of the study manager
    instituteId String
    The institute ID associated with this role

    CdlResearchStudyUploader, CdlResearchStudyUploaderArgs

    Email string
    The email address for this uploader (for display purposes)
    UserId string
    The IAM user ID of the uploader
    InstituteId string
    The institute ID associated with this role
    Email string
    The email address for this uploader (for display purposes)
    UserId string
    The IAM user ID of the uploader
    InstituteId string
    The institute ID associated with this role
    email String
    The email address for this uploader (for display purposes)
    userId String
    The IAM user ID of the uploader
    instituteId String
    The institute ID associated with this role
    email string
    The email address for this uploader (for display purposes)
    userId string
    The IAM user ID of the uploader
    instituteId string
    The institute ID associated with this role
    email str
    The email address for this uploader (for display purposes)
    user_id str
    The IAM user ID of the uploader
    institute_id str
    The institute ID associated with this role
    email String
    The email address for this uploader (for display purposes)
    userId String
    The IAM user ID of the uploader
    instituteId String
    The institute ID associated with this role

    Import

    $ pulumi import hsdp:index/cdlResearchStudy:CdlResearchStudy An existing research study can be imported using `hsdp_cdl_research_study`, e.g.
    
    $ pulumi import hsdp:index/cdlResearchStudy:CdlResearchStudy mystudy a-guid
    

    To learn more about importing existing cloud resources, see Importing resources.

    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