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

hsdp.DicomRepository

Explore with Pulumi AI

This resource manages a DICOM repository

Example Usage

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

const repo1 = new hsdp.DicomRepository("repo1", {
    configUrl: hsdp_dicom_store_config.dicom.config_url,
    organizationId: hsdp_iam_org.root_org.id,
    objectStoreId: hsdp_dicom_object_store.store1.id,
    notification: {
        organizationId: hsdp_iam_org.tenant1.id,
    },
});
Copy
import pulumi
import pulumi_hsdp as hsdp

repo1 = hsdp.DicomRepository("repo1",
    config_url=hsdp_dicom_store_config["dicom"]["config_url"],
    organization_id=hsdp_iam_org["root_org"]["id"],
    object_store_id=hsdp_dicom_object_store["store1"]["id"],
    notification={
        "organization_id": hsdp_iam_org["tenant1"]["id"],
    })
Copy
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.NewDicomRepository(ctx, "repo1", &hsdp.DicomRepositoryArgs{
			ConfigUrl:      pulumi.Any(hsdp_dicom_store_config.Dicom.Config_url),
			OrganizationId: pulumi.Any(hsdp_iam_org.Root_org.Id),
			ObjectStoreId:  pulumi.Any(hsdp_dicom_object_store.Store1.Id),
			Notification: &hsdp.DicomRepositoryNotificationArgs{
				OrganizationId: pulumi.Any(hsdp_iam_org.Tenant1.Id),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Hsdp = Pulumi.Hsdp;

return await Deployment.RunAsync(() => 
{
    var repo1 = new Hsdp.DicomRepository("repo1", new()
    {
        ConfigUrl = hsdp_dicom_store_config.Dicom.Config_url,
        OrganizationId = hsdp_iam_org.Root_org.Id,
        ObjectStoreId = hsdp_dicom_object_store.Store1.Id,
        Notification = new Hsdp.Inputs.DicomRepositoryNotificationArgs
        {
            OrganizationId = hsdp_iam_org.Tenant1.Id,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.hsdp.DicomRepository;
import com.pulumi.hsdp.DicomRepositoryArgs;
import com.pulumi.hsdp.inputs.DicomRepositoryNotificationArgs;
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 repo1 = new DicomRepository("repo1", DicomRepositoryArgs.builder()
            .configUrl(hsdp_dicom_store_config.dicom().config_url())
            .organizationId(hsdp_iam_org.root_org().id())
            .objectStoreId(hsdp_dicom_object_store.store1().id())
            .notification(DicomRepositoryNotificationArgs.builder()
                .organizationId(hsdp_iam_org.tenant1().id())
                .build())
            .build());

    }
}
Copy
resources:
  repo1:
    type: hsdp:DicomRepository
    properties:
      configUrl: ${hsdp_dicom_store_config.dicom.config_url}
      organizationId: ${hsdp_iam_org.root_org.id}
      objectStoreId: ${hsdp_dicom_object_store.store1.id}
      notification:
        organizationId: ${hsdp_iam_org.tenant1.id}
Copy

Create DicomRepository Resource

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

Constructor syntax

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

@overload
def DicomRepository(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    config_url: Optional[str] = None,
                    object_store_id: Optional[str] = None,
                    organization_id: Optional[str] = None,
                    dicom_repository_id: Optional[str] = None,
                    notification: Optional[DicomRepositoryNotificationArgs] = None,
                    repository_organization_id: Optional[str] = None,
                    store_as_composite: Optional[bool] = None)
func NewDicomRepository(ctx *Context, name string, args DicomRepositoryArgs, opts ...ResourceOption) (*DicomRepository, error)
public DicomRepository(string name, DicomRepositoryArgs args, CustomResourceOptions? opts = null)
public DicomRepository(String name, DicomRepositoryArgs args)
public DicomRepository(String name, DicomRepositoryArgs args, CustomResourceOptions options)
type: hsdp:DicomRepository
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DicomRepositoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DicomRepositoryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DicomRepositoryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DicomRepositoryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DicomRepositoryArgs
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 dicomRepositoryResource = new Hsdp.DicomRepository("dicomRepositoryResource", new()
{
    ConfigUrl = "string",
    ObjectStoreId = "string",
    OrganizationId = "string",
    DicomRepositoryId = "string",
    Notification = new Hsdp.Inputs.DicomRepositoryNotificationArgs
    {
        OrganizationId = "string",
        Enabled = false,
    },
    RepositoryOrganizationId = "string",
    StoreAsComposite = false,
});
Copy
example, err := hsdp.NewDicomRepository(ctx, "dicomRepositoryResource", &hsdp.DicomRepositoryArgs{
ConfigUrl: pulumi.String("string"),
ObjectStoreId: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
DicomRepositoryId: pulumi.String("string"),
Notification: &.DicomRepositoryNotificationArgs{
OrganizationId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
},
RepositoryOrganizationId: pulumi.String("string"),
StoreAsComposite: pulumi.Bool(false),
})
Copy
var dicomRepositoryResource = new DicomRepository("dicomRepositoryResource", DicomRepositoryArgs.builder()
    .configUrl("string")
    .objectStoreId("string")
    .organizationId("string")
    .dicomRepositoryId("string")
    .notification(DicomRepositoryNotificationArgs.builder()
        .organizationId("string")
        .enabled(false)
        .build())
    .repositoryOrganizationId("string")
    .storeAsComposite(false)
    .build());
Copy
dicom_repository_resource = hsdp.DicomRepository("dicomRepositoryResource",
    config_url="string",
    object_store_id="string",
    organization_id="string",
    dicom_repository_id="string",
    notification={
        "organization_id": "string",
        "enabled": False,
    },
    repository_organization_id="string",
    store_as_composite=False)
Copy
const dicomRepositoryResource = new hsdp.DicomRepository("dicomRepositoryResource", {
    configUrl: "string",
    objectStoreId: "string",
    organizationId: "string",
    dicomRepositoryId: "string",
    notification: {
        organizationId: "string",
        enabled: false,
    },
    repositoryOrganizationId: "string",
    storeAsComposite: false,
});
Copy
type: hsdp:DicomRepository
properties:
    configUrl: string
    dicomRepositoryId: string
    notification:
        enabled: false
        organizationId: string
    objectStoreId: string
    organizationId: string
    repositoryOrganizationId: string
    storeAsComposite: false
Copy

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

ConfigUrl This property is required. string
The base config URL of the DICOM Store instance
ObjectStoreId This property is required. string
the Object store ID
OrganizationId This property is required. string
The organization ID
DicomRepositoryId string
Notification DicomRepositoryNotification
RepositoryOrganizationId string
The organization ID attached to this repository. When not specified, the root organization is used.
StoreAsComposite bool
Configure this repository as store as composite.
ConfigUrl This property is required. string
The base config URL of the DICOM Store instance
ObjectStoreId This property is required. string
the Object store ID
OrganizationId This property is required. string
The organization ID
DicomRepositoryId string
Notification DicomRepositoryNotificationArgs
RepositoryOrganizationId string
The organization ID attached to this repository. When not specified, the root organization is used.
StoreAsComposite bool
Configure this repository as store as composite.
configUrl This property is required. String
The base config URL of the DICOM Store instance
objectStoreId This property is required. String
the Object store ID
organizationId This property is required. String
The organization ID
dicomRepositoryId String
notification DicomRepositoryNotification
repositoryOrganizationId String
The organization ID attached to this repository. When not specified, the root organization is used.
storeAsComposite Boolean
Configure this repository as store as composite.
configUrl This property is required. string
The base config URL of the DICOM Store instance
objectStoreId This property is required. string
the Object store ID
organizationId This property is required. string
The organization ID
dicomRepositoryId string
notification DicomRepositoryNotification
repositoryOrganizationId string
The organization ID attached to this repository. When not specified, the root organization is used.
storeAsComposite boolean
Configure this repository as store as composite.
config_url This property is required. str
The base config URL of the DICOM Store instance
object_store_id This property is required. str
the Object store ID
organization_id This property is required. str
The organization ID
dicom_repository_id str
notification DicomRepositoryNotificationArgs
repository_organization_id str
The organization ID attached to this repository. When not specified, the root organization is used.
store_as_composite bool
Configure this repository as store as composite.
configUrl This property is required. String
The base config URL of the DICOM Store instance
objectStoreId This property is required. String
the Object store ID
organizationId This property is required. String
The organization ID
dicomRepositoryId String
notification Property Map
repositoryOrganizationId String
The organization ID attached to this repository. When not specified, the root organization is used.
storeAsComposite Boolean
Configure this repository as store as composite.

Outputs

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

Get an existing DicomRepository 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?: DicomRepositoryState, opts?: CustomResourceOptions): DicomRepository
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_url: Optional[str] = None,
        dicom_repository_id: Optional[str] = None,
        notification: Optional[DicomRepositoryNotificationArgs] = None,
        object_store_id: Optional[str] = None,
        organization_id: Optional[str] = None,
        repository_organization_id: Optional[str] = None,
        store_as_composite: Optional[bool] = None) -> DicomRepository
func GetDicomRepository(ctx *Context, name string, id IDInput, state *DicomRepositoryState, opts ...ResourceOption) (*DicomRepository, error)
public static DicomRepository Get(string name, Input<string> id, DicomRepositoryState? state, CustomResourceOptions? opts = null)
public static DicomRepository get(String name, Output<String> id, DicomRepositoryState state, CustomResourceOptions options)
resources:  _:    type: hsdp:DicomRepository    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ConfigUrl string
The base config URL of the DICOM Store instance
DicomRepositoryId string
Notification DicomRepositoryNotification
ObjectStoreId string
the Object store ID
OrganizationId string
The organization ID
RepositoryOrganizationId string
The organization ID attached to this repository. When not specified, the root organization is used.
StoreAsComposite bool
Configure this repository as store as composite.
ConfigUrl string
The base config URL of the DICOM Store instance
DicomRepositoryId string
Notification DicomRepositoryNotificationArgs
ObjectStoreId string
the Object store ID
OrganizationId string
The organization ID
RepositoryOrganizationId string
The organization ID attached to this repository. When not specified, the root organization is used.
StoreAsComposite bool
Configure this repository as store as composite.
configUrl String
The base config URL of the DICOM Store instance
dicomRepositoryId String
notification DicomRepositoryNotification
objectStoreId String
the Object store ID
organizationId String
The organization ID
repositoryOrganizationId String
The organization ID attached to this repository. When not specified, the root organization is used.
storeAsComposite Boolean
Configure this repository as store as composite.
configUrl string
The base config URL of the DICOM Store instance
dicomRepositoryId string
notification DicomRepositoryNotification
objectStoreId string
the Object store ID
organizationId string
The organization ID
repositoryOrganizationId string
The organization ID attached to this repository. When not specified, the root organization is used.
storeAsComposite boolean
Configure this repository as store as composite.
config_url str
The base config URL of the DICOM Store instance
dicom_repository_id str
notification DicomRepositoryNotificationArgs
object_store_id str
the Object store ID
organization_id str
The organization ID
repository_organization_id str
The organization ID attached to this repository. When not specified, the root organization is used.
store_as_composite bool
Configure this repository as store as composite.
configUrl String
The base config URL of the DICOM Store instance
dicomRepositoryId String
notification Property Map
objectStoreId String
the Object store ID
organizationId String
The organization ID
repositoryOrganizationId String
The organization ID attached to this repository. When not specified, the root organization is used.
storeAsComposite Boolean
Configure this repository as store as composite.

Supporting Types

DicomRepositoryNotification
, DicomRepositoryNotificationArgs

OrganizationId This property is required. string
the tenant IAM Organization ID
Enabled bool
Enable notifications or not. Default: true
OrganizationId This property is required. string
the tenant IAM Organization ID
Enabled bool
Enable notifications or not. Default: true
organizationId This property is required. String
the tenant IAM Organization ID
enabled Boolean
Enable notifications or not. Default: true
organizationId This property is required. string
the tenant IAM Organization ID
enabled boolean
Enable notifications or not. Default: true
organization_id This property is required. str
the tenant IAM Organization ID
enabled bool
Enable notifications or not. Default: true
organizationId This property is required. String
the tenant IAM Organization ID
enabled Boolean
Enable notifications or not. Default: true

Package Details

Repository
hsdp philips-software/terraform-provider-hsdp
License
Notes
This Pulumi package is based on the hsdp Terraform Provider.