DicomStore

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:

API documentation
How-to Guides
- Creating a DICOM store

Create a DicomStore Resource

new DicomStore(name: string, args: DicomStoreArgs, opts?: CustomResourceOptions);

def DicomStore(resource_name, opts=None, dataset=None, labels=None, name=None, notification_config=None, __props__=None);

func NewDicomStore(ctx *Context, name string, args DicomStoreArgs, opts ...ResourceOption) (*DicomStore, error)

public DicomStore(string name, DicomStoreArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

DicomStore Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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” }.
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.

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” }.
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.

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” }.
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.

dataset str: Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
labels Dict[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” }.
name str: The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
notification_config Dict[DicomStoreNotificationConfig]: A nested object resource Structure is documented below.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The fully qualified name of this dataset

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The fully qualified name of this dataset

id string: The provider-assigned unique ID for this managed resource.
selfLink string: The fully qualified name of this dataset

id str: The provider-assigned unique ID for this managed resource.
self_link str: The fully qualified name of this dataset

Look up an 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

static get(resource_name, id, opts=None, dataset=None, labels=None, name=None, notification_config=None, self_link=None, __props__=None);

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)

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.

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}’
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” }.
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.
SelfLink string: The fully qualified name of this dataset

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” }.
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.
SelfLink string: The fully qualified name of this dataset

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” }.
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.
selfLink string: The fully qualified name of this dataset

dataset str: Identifies the dataset addressed by this request. Must be in the format ‘projects/{project}/locations/{location}/datasets/{dataset}’
labels Dict[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” }.
name str: The resource name for the DicomStore. ** Changing this property may recreate the Dicom store (removing all data) **
notification_config Dict[DicomStoreNotificationConfig]: A nested object resource Structure is documented below.
self_link str: The fully qualified name of this dataset

Supporting Types

DicomStoreNotificationConfig

See the input and output API doc for this type.

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. cloud-healthcare@system.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. cloud-healthcare@system.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. cloud-healthcare@system.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 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. cloud-healthcare@system.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.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud