1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. healthcare
  5. DicomStore
Google Cloud Classic v7.16.0 published on Wednesday, Mar 27, 2024 by Pulumi

gcp.healthcare.DicomStore

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.16.0 published on Wednesday, Mar 27, 2024 by Pulumi

    A DicomStore is a datastore inside a Healthcare dataset that conforms to the DICOM (https://www.dicomstandard.org/about/) standard for Healthcare information exchange

    To get more information about DicomStore, see:

    Example Usage

    Healthcare Dicom Store Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const topic = new gcp.pubsub.Topic("topic", {name: "dicom-notifications"});
    const dataset = new gcp.healthcare.Dataset("dataset", {
        name: "example-dataset",
        location: "us-central1",
    });
    const _default = new gcp.healthcare.DicomStore("default", {
        name: "example-dicom-store",
        dataset: dataset.id,
        notificationConfig: {
            pubsubTopic: topic.id,
        },
        labels: {
            label1: "labelvalue1",
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    topic = gcp.pubsub.Topic("topic", name="dicom-notifications")
    dataset = gcp.healthcare.Dataset("dataset",
        name="example-dataset",
        location="us-central1")
    default = gcp.healthcare.DicomStore("default",
        name="example-dicom-store",
        dataset=dataset.id,
        notification_config=gcp.healthcare.DicomStoreNotificationConfigArgs(
            pubsub_topic=topic.id,
        ),
        labels={
            "label1": "labelvalue1",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/healthcare"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/pubsub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		topic, err := pubsub.NewTopic(ctx, "topic", &pubsub.TopicArgs{
    			Name: pulumi.String("dicom-notifications"),
    		})
    		if err != nil {
    			return err
    		}
    		dataset, err := healthcare.NewDataset(ctx, "dataset", &healthcare.DatasetArgs{
    			Name:     pulumi.String("example-dataset"),
    			Location: pulumi.String("us-central1"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = healthcare.NewDicomStore(ctx, "default", &healthcare.DicomStoreArgs{
    			Name:    pulumi.String("example-dicom-store"),
    			Dataset: dataset.ID(),
    			NotificationConfig: &healthcare.DicomStoreNotificationConfigArgs{
    				PubsubTopic: topic.ID(),
    			},
    			Labels: pulumi.StringMap{
    				"label1": pulumi.String("labelvalue1"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var topic = new Gcp.PubSub.Topic("topic", new()
        {
            Name = "dicom-notifications",
        });
    
        var dataset = new Gcp.Healthcare.Dataset("dataset", new()
        {
            Name = "example-dataset",
            Location = "us-central1",
        });
    
        var @default = new Gcp.Healthcare.DicomStore("default", new()
        {
            Name = "example-dicom-store",
            Dataset = dataset.Id,
            NotificationConfig = new Gcp.Healthcare.Inputs.DicomStoreNotificationConfigArgs
            {
                PubsubTopic = topic.Id,
            },
            Labels = 
            {
                { "label1", "labelvalue1" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.pubsub.Topic;
    import com.pulumi.gcp.pubsub.TopicArgs;
    import com.pulumi.gcp.healthcare.Dataset;
    import com.pulumi.gcp.healthcare.DatasetArgs;
    import com.pulumi.gcp.healthcare.DicomStore;
    import com.pulumi.gcp.healthcare.DicomStoreArgs;
    import com.pulumi.gcp.healthcare.inputs.DicomStoreNotificationConfigArgs;
    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 topic = new Topic("topic", TopicArgs.builder()        
                .name("dicom-notifications")
                .build());
    
            var dataset = new Dataset("dataset", DatasetArgs.builder()        
                .name("example-dataset")
                .location("us-central1")
                .build());
    
            var default_ = new DicomStore("default", DicomStoreArgs.builder()        
                .name("example-dicom-store")
                .dataset(dataset.id())
                .notificationConfig(DicomStoreNotificationConfigArgs.builder()
                    .pubsubTopic(topic.id())
                    .build())
                .labels(Map.of("label1", "labelvalue1"))
                .build());
    
        }
    }
    
    resources:
      default:
        type: gcp:healthcare:DicomStore
        properties:
          name: example-dicom-store
          dataset: ${dataset.id}
          notificationConfig:
            pubsubTopic: ${topic.id}
          labels:
            label1: labelvalue1
      topic:
        type: gcp:pubsub:Topic
        properties:
          name: dicom-notifications
      dataset:
        type: gcp:healthcare:Dataset
        properties:
          name: example-dataset
          location: us-central1
    

    Healthcare Dicom Store Bq Stream

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const topic = new gcp.pubsub.Topic("topic", {name: "dicom-notifications"});
    const dataset = new gcp.healthcare.Dataset("dataset", {
        name: "example-dataset",
        location: "us-central1",
    });
    const bqDataset = new gcp.bigquery.Dataset("bq_dataset", {
        datasetId: "dicom_bq_ds",
        friendlyName: "test",
        description: "This is a test description",
        location: "US",
        deleteContentsOnDestroy: true,
    });
    const bqTable = new gcp.bigquery.Table("bq_table", {
        deletionProtection: false,
        datasetId: bqDataset.datasetId,
        tableId: "dicom_bq_tb",
    });
    const _default = new gcp.healthcare.DicomStore("default", {
        name: "example-dicom-store",
        dataset: dataset.id,
        notificationConfig: {
            pubsubTopic: topic.id,
        },
        labels: {
            label1: "labelvalue1",
        },
        streamConfigs: [{
            bigqueryDestination: {
                tableUri: pulumi.interpolate`bq://${bqDataset.project}.${bqDataset.datasetId}.${bqTable.tableId}`,
            },
        }],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    topic = gcp.pubsub.Topic("topic", name="dicom-notifications")
    dataset = gcp.healthcare.Dataset("dataset",
        name="example-dataset",
        location="us-central1")
    bq_dataset = gcp.bigquery.Dataset("bq_dataset",
        dataset_id="dicom_bq_ds",
        friendly_name="test",
        description="This is a test description",
        location="US",
        delete_contents_on_destroy=True)
    bq_table = gcp.bigquery.Table("bq_table",
        deletion_protection=False,
        dataset_id=bq_dataset.dataset_id,
        table_id="dicom_bq_tb")
    default = gcp.healthcare.DicomStore("default",
        name="example-dicom-store",
        dataset=dataset.id,
        notification_config=gcp.healthcare.DicomStoreNotificationConfigArgs(
            pubsub_topic=topic.id,
        ),
        labels={
            "label1": "labelvalue1",
        },
        stream_configs=[gcp.healthcare.DicomStoreStreamConfigArgs(
            bigquery_destination=gcp.healthcare.DicomStoreStreamConfigBigqueryDestinationArgs(
                table_uri=pulumi.Output.all(bq_dataset.project, bq_dataset.dataset_id, bq_table.table_id).apply(lambda project, dataset_id, table_id: f"bq://{project}.{dataset_id}.{table_id}"),
            ),
        )])
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/bigquery"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/healthcare"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/pubsub"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		topic, err := pubsub.NewTopic(ctx, "topic", &pubsub.TopicArgs{
    			Name: pulumi.String("dicom-notifications"),
    		})
    		if err != nil {
    			return err
    		}
    		dataset, err := healthcare.NewDataset(ctx, "dataset", &healthcare.DatasetArgs{
    			Name:     pulumi.String("example-dataset"),
    			Location: pulumi.String("us-central1"),
    		})
    		if err != nil {
    			return err
    		}
    		bqDataset, err := bigquery.NewDataset(ctx, "bq_dataset", &bigquery.DatasetArgs{
    			DatasetId:               pulumi.String("dicom_bq_ds"),
    			FriendlyName:            pulumi.String("test"),
    			Description:             pulumi.String("This is a test description"),
    			Location:                pulumi.String("US"),
    			DeleteContentsOnDestroy: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		bqTable, err := bigquery.NewTable(ctx, "bq_table", &bigquery.TableArgs{
    			DeletionProtection: pulumi.Bool(false),
    			DatasetId:          bqDataset.DatasetId,
    			TableId:            pulumi.String("dicom_bq_tb"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = healthcare.NewDicomStore(ctx, "default", &healthcare.DicomStoreArgs{
    			Name:    pulumi.String("example-dicom-store"),
    			Dataset: dataset.ID(),
    			NotificationConfig: &healthcare.DicomStoreNotificationConfigArgs{
    				PubsubTopic: topic.ID(),
    			},
    			Labels: pulumi.StringMap{
    				"label1": pulumi.String("labelvalue1"),
    			},
    			StreamConfigs: healthcare.DicomStoreStreamConfigArray{
    				&healthcare.DicomStoreStreamConfigArgs{
    					BigqueryDestination: &healthcare.DicomStoreStreamConfigBigqueryDestinationArgs{
    						TableUri: pulumi.All(bqDataset.Project, bqDataset.DatasetId, bqTable.TableId).ApplyT(func(_args []interface{}) (string, error) {
    							project := _args[0].(string)
    							datasetId := _args[1].(string)
    							tableId := _args[2].(string)
    							return fmt.Sprintf("bq://%v.%v.%v", project, datasetId, tableId), nil
    						}).(pulumi.StringOutput),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var topic = new Gcp.PubSub.Topic("topic", new()
        {
            Name = "dicom-notifications",
        });
    
        var dataset = new Gcp.Healthcare.Dataset("dataset", new()
        {
            Name = "example-dataset",
            Location = "us-central1",
        });
    
        var bqDataset = new Gcp.BigQuery.Dataset("bq_dataset", new()
        {
            DatasetId = "dicom_bq_ds",
            FriendlyName = "test",
            Description = "This is a test description",
            Location = "US",
            DeleteContentsOnDestroy = true,
        });
    
        var bqTable = new Gcp.BigQuery.Table("bq_table", new()
        {
            DeletionProtection = false,
            DatasetId = bqDataset.DatasetId,
            TableId = "dicom_bq_tb",
        });
    
        var @default = new Gcp.Healthcare.DicomStore("default", new()
        {
            Name = "example-dicom-store",
            Dataset = dataset.Id,
            NotificationConfig = new Gcp.Healthcare.Inputs.DicomStoreNotificationConfigArgs
            {
                PubsubTopic = topic.Id,
            },
            Labels = 
            {
                { "label1", "labelvalue1" },
            },
            StreamConfigs = new[]
            {
                new Gcp.Healthcare.Inputs.DicomStoreStreamConfigArgs
                {
                    BigqueryDestination = new Gcp.Healthcare.Inputs.DicomStoreStreamConfigBigqueryDestinationArgs
                    {
                        TableUri = Output.Tuple(bqDataset.Project, bqDataset.DatasetId, bqTable.TableId).Apply(values =>
                        {
                            var project = values.Item1;
                            var datasetId = values.Item2;
                            var tableId = values.Item3;
                            return $"bq://{project}.{datasetId}.{tableId}";
                        }),
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.pubsub.Topic;
    import com.pulumi.gcp.pubsub.TopicArgs;
    import com.pulumi.gcp.healthcare.Dataset;
    import com.pulumi.gcp.healthcare.DatasetArgs;
    import com.pulumi.gcp.bigquery.Dataset;
    import com.pulumi.gcp.bigquery.DatasetArgs;
    import com.pulumi.gcp.bigquery.Table;
    import com.pulumi.gcp.bigquery.TableArgs;
    import com.pulumi.gcp.healthcare.DicomStore;
    import com.pulumi.gcp.healthcare.DicomStoreArgs;
    import com.pulumi.gcp.healthcare.inputs.DicomStoreNotificationConfigArgs;
    import com.pulumi.gcp.healthcare.inputs.DicomStoreStreamConfigArgs;
    import com.pulumi.gcp.healthcare.inputs.DicomStoreStreamConfigBigqueryDestinationArgs;
    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 topic = new Topic("topic", TopicArgs.builder()        
                .name("dicom-notifications")
                .build());
    
            var dataset = new Dataset("dataset", DatasetArgs.builder()        
                .name("example-dataset")
                .location("us-central1")
                .build());
    
            var bqDataset = new Dataset("bqDataset", DatasetArgs.builder()        
                .datasetId("dicom_bq_ds")
                .friendlyName("test")
                .description("This is a test description")
                .location("US")
                .deleteContentsOnDestroy(true)
                .build());
    
            var bqTable = new Table("bqTable", TableArgs.builder()        
                .deletionProtection(false)
                .datasetId(bqDataset.datasetId())
                .tableId("dicom_bq_tb")
                .build());
    
            var default_ = new DicomStore("default", DicomStoreArgs.builder()        
                .name("example-dicom-store")
                .dataset(dataset.id())
                .notificationConfig(DicomStoreNotificationConfigArgs.builder()
                    .pubsubTopic(topic.id())
                    .build())
                .labels(Map.of("label1", "labelvalue1"))
                .streamConfigs(DicomStoreStreamConfigArgs.builder()
                    .bigqueryDestination(DicomStoreStreamConfigBigqueryDestinationArgs.builder()
                        .tableUri(Output.tuple(bqDataset.project(), bqDataset.datasetId(), bqTable.tableId()).applyValue(values -> {
                            var project = values.t1;
                            var datasetId = values.t2;
                            var tableId = values.t3;
                            return String.format("bq://%s.%s.%s", project,datasetId,tableId);
                        }))
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      default:
        type: gcp:healthcare:DicomStore
        properties:
          name: example-dicom-store
          dataset: ${dataset.id}
          notificationConfig:
            pubsubTopic: ${topic.id}
          labels:
            label1: labelvalue1
          streamConfigs:
            - bigqueryDestination:
                tableUri: bq://${bqDataset.project}.${bqDataset.datasetId}.${bqTable.tableId}
      topic:
        type: gcp:pubsub:Topic
        properties:
          name: dicom-notifications
      dataset:
        type: gcp:healthcare:Dataset
        properties:
          name: example-dataset
          location: us-central1
      bqDataset:
        type: gcp:bigquery:Dataset
        name: bq_dataset
        properties:
          datasetId: dicom_bq_ds
          friendlyName: test
          description: This is a test description
          location: US
          deleteContentsOnDestroy: true
      bqTable:
        type: gcp:bigquery:Table
        name: bq_table
        properties:
          deletionProtection: false
          datasetId: ${bqDataset.datasetId}
          tableId: dicom_bq_tb
    

    Create DicomStore Resource

    new DicomStore(name: string, args: DicomStoreArgs, opts?: CustomResourceOptions);
    @overload
    def DicomStore(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   dataset: Optional[str] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   name: Optional[str] = None,
                   notification_config: Optional[DicomStoreNotificationConfigArgs] = None,
                   stream_configs: Optional[Sequence[DicomStoreStreamConfigArgs]] = None)
    @overload
    def DicomStore(resource_name: str,
                   args: DicomStoreArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewDicomStore(ctx *Context, name string, args DicomStoreArgs, opts ...ResourceOption) (*DicomStore, error)
    public DicomStore(string name, DicomStoreArgs args, CustomResourceOptions? opts = null)
    public DicomStore(String name, DicomStoreArgs args)
    public DicomStore(String name, DicomStoreArgs args, CustomResourceOptions options)
    
    type: gcp:healthcare:DicomStore
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DicomStoreArgs
    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 DicomStoreArgs
    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 DicomStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DicomStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DicomStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DicomStore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DicomStore resource accepts the following input properties:

    Dataset string
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    Labels Dictionary<string, string>

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Name string
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    NotificationConfig DicomStoreNotificationConfig
    A nested object resource Structure is documented below.
    StreamConfigs List<DicomStoreStreamConfig>
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    Dataset string
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    Labels map[string]string

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Name string
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    NotificationConfig DicomStoreNotificationConfigArgs
    A nested object resource Structure is documented below.
    StreamConfigs []DicomStoreStreamConfigArgs
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    dataset String
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    labels Map<String,String>

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name String
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    notificationConfig DicomStoreNotificationConfig
    A nested object resource Structure is documented below.
    streamConfigs List<DicomStoreStreamConfig>
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    dataset string
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    labels {[key: string]: string}

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name string
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    notificationConfig DicomStoreNotificationConfig
    A nested object resource Structure is documented below.
    streamConfigs DicomStoreStreamConfig[]
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    dataset str
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    labels Mapping[str, str]

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name str
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    notification_config DicomStoreNotificationConfigArgs
    A nested object resource Structure is documented below.
    stream_configs Sequence[DicomStoreStreamConfigArgs]
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    dataset String
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    labels Map<String>

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name String
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    notificationConfig Property Map
    A nested object resource Structure is documented below.
    streamConfigs List<Property Map>
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.

    Outputs

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

    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    SelfLink string
    The fully qualified name of this dataset
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    SelfLink string
    The fully qualified name of this dataset
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink String
    The fully qualified name of this dataset
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink string
    The fully qualified name of this dataset
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    self_link str
    The fully qualified name of this dataset
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink String
    The fully qualified name of this dataset

    Look up Existing DicomStore Resource

    Get an existing DicomStore 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?: DicomStoreState, opts?: CustomResourceOptions): DicomStore
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dataset: Optional[str] = None,
            effective_labels: Optional[Mapping[str, str]] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            notification_config: Optional[DicomStoreNotificationConfigArgs] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            self_link: Optional[str] = None,
            stream_configs: Optional[Sequence[DicomStoreStreamConfigArgs]] = None) -> DicomStore
    func GetDicomStore(ctx *Context, name string, id IDInput, state *DicomStoreState, opts ...ResourceOption) (*DicomStore, error)
    public static DicomStore Get(string name, Input<string> id, DicomStoreState? state, CustomResourceOptions? opts = null)
    public static DicomStore get(String name, Output<String> id, DicomStoreState 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:
    Dataset string
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels Dictionary<string, string>

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Name string
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    NotificationConfig DicomStoreNotificationConfig
    A nested object resource Structure is documented below.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    SelfLink string
    The fully qualified name of this dataset
    StreamConfigs List<DicomStoreStreamConfig>
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    Dataset string
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Labels map[string]string

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    Name string
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    NotificationConfig DicomStoreNotificationConfigArgs
    A nested object resource Structure is documented below.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    SelfLink string
    The fully qualified name of this dataset
    StreamConfigs []DicomStoreStreamConfigArgs
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    dataset String
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String,String>

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name String
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    notificationConfig DicomStoreNotificationConfig
    A nested object resource Structure is documented below.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink String
    The fully qualified name of this dataset
    streamConfigs List<DicomStoreStreamConfig>
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    dataset string
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels {[key: string]: string}

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name string
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    notificationConfig DicomStoreNotificationConfig
    A nested object resource Structure is documented below.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink string
    The fully qualified name of this dataset
    streamConfigs DicomStoreStreamConfig[]
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    dataset str
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Mapping[str, str]

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name str
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    notification_config DicomStoreNotificationConfigArgs
    A nested object resource Structure is documented below.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    self_link str
    The fully qualified name of this dataset
    stream_configs Sequence[DicomStoreStreamConfigArgs]
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.
    dataset String
    Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'


    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    labels Map<String>

    User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}-]{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}-]{0,63} No more than 64 labels can be associated with a given store. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

    Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

    name String
    The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
    notificationConfig Property Map
    A nested object resource Structure is documented below.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    selfLink String
    The fully qualified name of this dataset
    streamConfigs List<Property Map>
    To enable streaming to BigQuery, configure the streamConfigs object in your DICOM store. streamConfigs is an array, so you can specify multiple BigQuery destinations. You can stream metadata from a single DICOM store to up to five BigQuery tables in a BigQuery dataset. Structure is documented below.

    Supporting Types

    DicomStoreNotificationConfig, DicomStoreNotificationConfigArgs

    PubsubTopic string
    The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
    PubsubTopic string
    The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
    pubsubTopic String
    The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
    pubsubTopic string
    The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
    pubsub_topic str
    The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
    pubsubTopic String
    The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.

    DicomStoreStreamConfig, DicomStoreStreamConfigArgs

    BigqueryDestination DicomStoreStreamConfigBigqueryDestination
    BigQueryDestination to include a fully qualified BigQuery table URI where DICOM instance metadata will be streamed. Structure is documented below.
    BigqueryDestination DicomStoreStreamConfigBigqueryDestination
    BigQueryDestination to include a fully qualified BigQuery table URI where DICOM instance metadata will be streamed. Structure is documented below.
    bigqueryDestination DicomStoreStreamConfigBigqueryDestination
    BigQueryDestination to include a fully qualified BigQuery table URI where DICOM instance metadata will be streamed. Structure is documented below.
    bigqueryDestination DicomStoreStreamConfigBigqueryDestination
    BigQueryDestination to include a fully qualified BigQuery table URI where DICOM instance metadata will be streamed. Structure is documented below.
    bigquery_destination DicomStoreStreamConfigBigqueryDestination
    BigQueryDestination to include a fully qualified BigQuery table URI where DICOM instance metadata will be streamed. Structure is documented below.
    bigqueryDestination Property Map
    BigQueryDestination to include a fully qualified BigQuery table URI where DICOM instance metadata will be streamed. Structure is documented below.

    DicomStoreStreamConfigBigqueryDestination, DicomStoreStreamConfigBigqueryDestinationArgs

    TableUri string
    a fully qualified BigQuery table URI where DICOM instance metadata will be streamed.
    TableUri string
    a fully qualified BigQuery table URI where DICOM instance metadata will be streamed.
    tableUri String
    a fully qualified BigQuery table URI where DICOM instance metadata will be streamed.
    tableUri string
    a fully qualified BigQuery table URI where DICOM instance metadata will be streamed.
    table_uri str
    a fully qualified BigQuery table URI where DICOM instance metadata will be streamed.
    tableUri String
    a fully qualified BigQuery table URI where DICOM instance metadata will be streamed.

    Import

    DicomStore can be imported using any of these accepted formats:

    • {{dataset}}/dicomStores/{{name}}

    • {{dataset}}/{{name}}

    When using the pulumi import command, DicomStore can be imported using one of the formats above. For example:

    $ pulumi import gcp:healthcare/dicomStore:DicomStore default {{dataset}}/dicomStores/{{name}}
    
    $ pulumi import gcp:healthcare/dicomStore:DicomStore default {{dataset}}/{{name}}
    

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.16.0 published on Wednesday, Mar 27, 2024 by Pulumi