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

hsdp.CdlDataTypeDefinition

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) Data Type Definitions.

    Example Usage

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

const defA = new hsdp.CdlDataTypeDefinition("defA", {
    cdlEndpoint: data.cdl_instance.cicd.endpoint,
    jsonSchema: `{
 "required": [
  "email"
 ],
 "properties": {
  "name": {
   "type": "string"
  },
  "email": {
   "type": "string"
  },
  "birthdate": {
   "type": "string"
  }
 }
}
`,
});

    import pulumi
import pulumi_hsdp as hsdp

def_a = hsdp.CdlDataTypeDefinition("defA",
    cdl_endpoint=data["cdl_instance"]["cicd"]["endpoint"],
    json_schema="""{
 "required": [
  "email"
 ],
 "properties": {
  "name": {
   "type": "string"
  },
  "email": {
   "type": "string"
  },
  "birthdate": {
   "type": "string"
  }
 }
}
""")

    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.NewCdlDataTypeDefinition(ctx, "defA", &hsdp.CdlDataTypeDefinitionArgs{
			CdlEndpoint: pulumi.Any(data.Cdl_instance.Cicd.Endpoint),
			JsonSchema: pulumi.String(`{
 "required": [
  "email"
 ],
 "properties": {
  "name": {
   "type": "string"
  },
  "email": {
   "type": "string"
  },
  "birthdate": {
   "type": "string"
  }
 }
}
`),
		})
		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 defA = new Hsdp.CdlDataTypeDefinition("defA", new()
    {
        CdlEndpoint = data.Cdl_instance.Cicd.Endpoint,
        JsonSchema = @"{
 ""required"": [
  ""email""
 ],
 ""properties"": {
  ""name"": {
   ""type"": ""string""
  },
  ""email"": {
   ""type"": ""string""
  },
  ""birthdate"": {
   ""type"": ""string""
  }
 }
}
",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hsdp.CdlDataTypeDefinition;
import com.pulumi.hsdp.CdlDataTypeDefinitionArgs;
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 defA = new CdlDataTypeDefinition("defA", CdlDataTypeDefinitionArgs.builder()
            .cdlEndpoint(data.cdl_instance().cicd().endpoint())
            .jsonSchema("""
{
 "required": [
  "email"
 ],
 "properties": {
  "name": {
   "type": "string"
  },
  "email": {
   "type": "string"
  },
  "birthdate": {
   "type": "string"
  }
 }
}
            """)
            .build());

    }
}

    resources:
  defA:
    type: hsdp:CdlDataTypeDefinition
    properties:
      cdlEndpoint: ${data.cdl_instance.cicd.endpoint}
      jsonSchema: |
        {
         "required": [
          "email"
         ],
         "properties": {
          "name": {
           "type": "string"
          },
          "email": {
           "type": "string"
          },
          "birthdate": {
           "type": "string"
          }
         }
        }

    Create CdlDataTypeDefinition Resource

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

    Constructor syntax

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

@overload
def CdlDataTypeDefinition(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          cdl_endpoint: Optional[str] = None,
                          cdl_data_type_definition_id: Optional[str] = None,
                          description: Optional[str] = None,
                          json_schema: Optional[str] = None,
                          name: Optional[str] = None)
    func NewCdlDataTypeDefinition(ctx *Context, name string, args CdlDataTypeDefinitionArgs, opts ...ResourceOption) (*CdlDataTypeDefinition, error)
    public CdlDataTypeDefinition(string name, CdlDataTypeDefinitionArgs args, CustomResourceOptions? opts = null)
    public CdlDataTypeDefinition(String name, CdlDataTypeDefinitionArgs args)
public CdlDataTypeDefinition(String name, CdlDataTypeDefinitionArgs args, CustomResourceOptions options)

    type: hsdp:CdlDataTypeDefinition
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 CdlDataTypeDefinitionArgs
    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 CdlDataTypeDefinitionArgs
    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 CdlDataTypeDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CdlDataTypeDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CdlDataTypeDefinitionArgs
    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 cdlDataTypeDefinitionResource = new Hsdp.CdlDataTypeDefinition("cdlDataTypeDefinitionResource", new()
{
    CdlEndpoint = "string",
    CdlDataTypeDefinitionId = "string",
    Description = "string",
    JsonSchema = "string",
    Name = "string",
});

    example, err := hsdp.NewCdlDataTypeDefinition(ctx, "cdlDataTypeDefinitionResource", &hsdp.CdlDataTypeDefinitionArgs{
	CdlEndpoint:             pulumi.String("string"),
	CdlDataTypeDefinitionId: pulumi.String("string"),
	Description:             pulumi.String("string"),
	JsonSchema:              pulumi.String("string"),
	Name:                    pulumi.String("string"),
})

    var cdlDataTypeDefinitionResource = new CdlDataTypeDefinition("cdlDataTypeDefinitionResource", CdlDataTypeDefinitionArgs.builder()
    .cdlEndpoint("string")
    .cdlDataTypeDefinitionId("string")
    .description("string")
    .jsonSchema("string")
    .name("string")
    .build());

    cdl_data_type_definition_resource = hsdp.CdlDataTypeDefinition("cdlDataTypeDefinitionResource",
    cdl_endpoint="string",
    cdl_data_type_definition_id="string",
    description="string",
    json_schema="string",
    name="string")

    const cdlDataTypeDefinitionResource = new hsdp.CdlDataTypeDefinition("cdlDataTypeDefinitionResource", {
    cdlEndpoint: "string",
    cdlDataTypeDefinitionId: "string",
    description: "string",
    jsonSchema: "string",
    name: "string",
});

    type: hsdp:CdlDataTypeDefinition
properties:
    cdlDataTypeDefinitionId: string
    cdlEndpoint: string
    description: string
    jsonSchema: string
    name: string

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

    CdlEndpoint string
    The CDL instance endpoint to query
    CdlDataTypeDefinitionId string
    The GUID of the DTDT
    Description string
    The description of the DTD
    JsonSchema string
    The JSON Schema describing the DTD
    Name string
    The name of the DTD
    CdlEndpoint string
    The CDL instance endpoint to query
    CdlDataTypeDefinitionId string
    The GUID of the DTDT
    Description string
    The description of the DTD
    JsonSchema string
    The JSON Schema describing the DTD
    Name string
    The name of the DTD
    cdlEndpoint String
    The CDL instance endpoint to query
    cdlDataTypeDefinitionId String
    The GUID of the DTDT
    description String
    The description of the DTD
    jsonSchema String
    The JSON Schema describing the DTD
    name String
    The name of the DTD
    cdlEndpoint string
    The CDL instance endpoint to query
    cdlDataTypeDefinitionId string
    The GUID of the DTDT
    description string
    The description of the DTD
    jsonSchema string
    The JSON Schema describing the DTD
    name string
    The name of the DTD
    cdl_endpoint str
    The CDL instance endpoint to query
    cdl_data_type_definition_id str
    The GUID of the DTDT
    description str
    The description of the DTD
    json_schema str
    The JSON Schema describing the DTD
    name str
    The name of the DTD
    cdlEndpoint String
    The CDL instance endpoint to query
    cdlDataTypeDefinitionId String
    The GUID of the DTDT
    description String
    The description of the DTD
    jsonSchema String
    The JSON Schema describing the DTD
    name String
    The name of the DTD

    Outputs

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

    Get an existing CdlDataTypeDefinition 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?: CdlDataTypeDefinitionState, opts?: CustomResourceOptions): CdlDataTypeDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cdl_data_type_definition_id: Optional[str] = None,
        cdl_endpoint: Optional[str] = None,
        description: Optional[str] = None,
        json_schema: Optional[str] = None,
        name: Optional[str] = None) -> CdlDataTypeDefinition
    func GetCdlDataTypeDefinition(ctx *Context, name string, id IDInput, state *CdlDataTypeDefinitionState, opts ...ResourceOption) (*CdlDataTypeDefinition, error)
    public static CdlDataTypeDefinition Get(string name, Input<string> id, CdlDataTypeDefinitionState? state, CustomResourceOptions? opts = null)
    public static CdlDataTypeDefinition get(String name, Output<String> id, CdlDataTypeDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:CdlDataTypeDefinition    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:
    CdlDataTypeDefinitionId string
    The GUID of the DTDT
    CdlEndpoint string
    The CDL instance endpoint to query
    Description string
    The description of the DTD
    JsonSchema string
    The JSON Schema describing the DTD
    Name string
    The name of the DTD
    CdlDataTypeDefinitionId string
    The GUID of the DTDT
    CdlEndpoint string
    The CDL instance endpoint to query
    Description string
    The description of the DTD
    JsonSchema string
    The JSON Schema describing the DTD
    Name string
    The name of the DTD
    cdlDataTypeDefinitionId String
    The GUID of the DTDT
    cdlEndpoint String
    The CDL instance endpoint to query
    description String
    The description of the DTD
    jsonSchema String
    The JSON Schema describing the DTD
    name String
    The name of the DTD
    cdlDataTypeDefinitionId string
    The GUID of the DTDT
    cdlEndpoint string
    The CDL instance endpoint to query
    description string
    The description of the DTD
    jsonSchema string
    The JSON Schema describing the DTD
    name string
    The name of the DTD
    cdl_data_type_definition_id str
    The GUID of the DTDT
    cdl_endpoint str
    The CDL instance endpoint to query
    description str
    The description of the DTD
    json_schema str
    The JSON Schema describing the DTD
    name str
    The name of the DTD
    cdlDataTypeDefinitionId String
    The GUID of the DTDT
    cdlEndpoint String
    The CDL instance endpoint to query
    description String
    The description of the DTD
    jsonSchema String
    The JSON Schema describing the DTD
    name String
    The name of the DTD

    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