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

hsdp.DicomNotification

Explore with Pulumi AI

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

    This resource manages a DICOM notification configurations

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const topic = new hsdp.DicomNotification("topic", {
        configUrl: hsdp_dicom_store_config.dicom.config_url,
        endpointUrl: _var.notification_endpoint_url,
        defaultOrganizationId: hsdp_iam_org.tenant1.id,
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    topic = hsdp.DicomNotification("topic",
        config_url=hsdp_dicom_store_config["dicom"]["config_url"],
        endpoint_url=var["notification_endpoint_url"],
        default_organization_id=hsdp_iam_org["tenant1"]["id"])
    
    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.NewDicomNotification(ctx, "topic", &hsdp.DicomNotificationArgs{
    			ConfigUrl:             pulumi.Any(hsdp_dicom_store_config.Dicom.Config_url),
    			EndpointUrl:           pulumi.Any(_var.Notification_endpoint_url),
    			DefaultOrganizationId: pulumi.Any(hsdp_iam_org.Tenant1.Id),
    		})
    		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 topic = new Hsdp.DicomNotification("topic", new()
        {
            ConfigUrl = hsdp_dicom_store_config.Dicom.Config_url,
            EndpointUrl = @var.Notification_endpoint_url,
            DefaultOrganizationId = hsdp_iam_org.Tenant1.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.DicomNotification;
    import com.pulumi.hsdp.DicomNotificationArgs;
    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 DicomNotification("topic", DicomNotificationArgs.builder()
                .configUrl(hsdp_dicom_store_config.dicom().config_url())
                .endpointUrl(var_.notification_endpoint_url())
                .defaultOrganizationId(hsdp_iam_org.tenant1().id())
                .build());
    
        }
    }
    
    resources:
      topic:
        type: hsdp:DicomNotification
        properties:
          configUrl: ${hsdp_dicom_store_config.dicom.config_url}
          endpointUrl: ${var.notification_endpoint_url}
          defaultOrganizationId: ${hsdp_iam_org.tenant1.id}
    

    Create DicomNotification Resource

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

    Constructor syntax

    new DicomNotification(name: string, args: DicomNotificationArgs, opts?: CustomResourceOptions);
    @overload
    def DicomNotification(resource_name: str,
                          args: DicomNotificationArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def DicomNotification(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          config_url: Optional[str] = None,
                          endpoint_url: Optional[str] = None,
                          default_organization_id: Optional[str] = None,
                          dicom_notification_id: Optional[str] = None,
                          enabled: Optional[bool] = None,
                          organization_id: Optional[str] = None)
    func NewDicomNotification(ctx *Context, name string, args DicomNotificationArgs, opts ...ResourceOption) (*DicomNotification, error)
    public DicomNotification(string name, DicomNotificationArgs args, CustomResourceOptions? opts = null)
    public DicomNotification(String name, DicomNotificationArgs args)
    public DicomNotification(String name, DicomNotificationArgs args, CustomResourceOptions options)
    
    type: hsdp:DicomNotification
    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 DicomNotificationArgs
    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 DicomNotificationArgs
    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 DicomNotificationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DicomNotificationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DicomNotificationArgs
    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 dicomNotificationResource = new Hsdp.DicomNotification("dicomNotificationResource", new()
    {
        ConfigUrl = "string",
        EndpointUrl = "string",
        DefaultOrganizationId = "string",
        DicomNotificationId = "string",
        Enabled = false,
    });
    
    example, err := hsdp.NewDicomNotification(ctx, "dicomNotificationResource", &hsdp.DicomNotificationArgs{
    	ConfigUrl:             pulumi.String("string"),
    	EndpointUrl:           pulumi.String("string"),
    	DefaultOrganizationId: pulumi.String("string"),
    	DicomNotificationId:   pulumi.String("string"),
    	Enabled:               pulumi.Bool(false),
    })
    
    var dicomNotificationResource = new DicomNotification("dicomNotificationResource", DicomNotificationArgs.builder()
        .configUrl("string")
        .endpointUrl("string")
        .defaultOrganizationId("string")
        .dicomNotificationId("string")
        .enabled(false)
        .build());
    
    dicom_notification_resource = hsdp.DicomNotification("dicomNotificationResource",
        config_url="string",
        endpoint_url="string",
        default_organization_id="string",
        dicom_notification_id="string",
        enabled=False)
    
    const dicomNotificationResource = new hsdp.DicomNotification("dicomNotificationResource", {
        configUrl: "string",
        endpointUrl: "string",
        defaultOrganizationId: "string",
        dicomNotificationId: "string",
        enabled: false,
    });
    
    type: hsdp:DicomNotification
    properties:
        configUrl: string
        defaultOrganizationId: string
        dicomNotificationId: string
        enabled: false
        endpointUrl: string
    

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

    ConfigUrl string
    The base config URL of the DICOM Store instance
    EndpointUrl string
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    DefaultOrganizationId string
    The default organization ID
    DicomNotificationId string
    Enabled bool
    Enable the notification or not. Default: true
    OrganizationId string

    Deprecated: Deprecated

    ConfigUrl string
    The base config URL of the DICOM Store instance
    EndpointUrl string
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    DefaultOrganizationId string
    The default organization ID
    DicomNotificationId string
    Enabled bool
    Enable the notification or not. Default: true
    OrganizationId string

    Deprecated: Deprecated

    configUrl String
    The base config URL of the DICOM Store instance
    endpointUrl String
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    defaultOrganizationId String
    The default organization ID
    dicomNotificationId String
    enabled Boolean
    Enable the notification or not. Default: true
    organizationId String

    Deprecated: Deprecated

    configUrl string
    The base config URL of the DICOM Store instance
    endpointUrl string
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    defaultOrganizationId string
    The default organization ID
    dicomNotificationId string
    enabled boolean
    Enable the notification or not. Default: true
    organizationId string

    Deprecated: Deprecated

    config_url str
    The base config URL of the DICOM Store instance
    endpoint_url str
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    default_organization_id str
    The default organization ID
    dicom_notification_id str
    enabled bool
    Enable the notification or not. Default: true
    organization_id str

    Deprecated: Deprecated

    configUrl String
    The base config URL of the DICOM Store instance
    endpointUrl String
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    defaultOrganizationId String
    The default organization ID
    dicomNotificationId String
    enabled Boolean
    Enable the notification or not. Default: true
    organizationId String

    Deprecated: Deprecated

    Outputs

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

    Get an existing DicomNotification 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?: DicomNotificationState, opts?: CustomResourceOptions): DicomNotification
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            config_url: Optional[str] = None,
            default_organization_id: Optional[str] = None,
            dicom_notification_id: Optional[str] = None,
            enabled: Optional[bool] = None,
            endpoint_url: Optional[str] = None,
            organization_id: Optional[str] = None) -> DicomNotification
    func GetDicomNotification(ctx *Context, name string, id IDInput, state *DicomNotificationState, opts ...ResourceOption) (*DicomNotification, error)
    public static DicomNotification Get(string name, Input<string> id, DicomNotificationState? state, CustomResourceOptions? opts = null)
    public static DicomNotification get(String name, Output<String> id, DicomNotificationState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:DicomNotification    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:
    ConfigUrl string
    The base config URL of the DICOM Store instance
    DefaultOrganizationId string
    The default organization ID
    DicomNotificationId string
    Enabled bool
    Enable the notification or not. Default: true
    EndpointUrl string
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    OrganizationId string

    Deprecated: Deprecated

    ConfigUrl string
    The base config URL of the DICOM Store instance
    DefaultOrganizationId string
    The default organization ID
    DicomNotificationId string
    Enabled bool
    Enable the notification or not. Default: true
    EndpointUrl string
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    OrganizationId string

    Deprecated: Deprecated

    configUrl String
    The base config URL of the DICOM Store instance
    defaultOrganizationId String
    The default organization ID
    dicomNotificationId String
    enabled Boolean
    Enable the notification or not. Default: true
    endpointUrl String
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    organizationId String

    Deprecated: Deprecated

    configUrl string
    The base config URL of the DICOM Store instance
    defaultOrganizationId string
    The default organization ID
    dicomNotificationId string
    enabled boolean
    Enable the notification or not. Default: true
    endpointUrl string
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    organizationId string

    Deprecated: Deprecated

    config_url str
    The base config URL of the DICOM Store instance
    default_organization_id str
    The default organization ID
    dicom_notification_id str
    enabled bool
    Enable the notification or not. Default: true
    endpoint_url str
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    organization_id str

    Deprecated: Deprecated

    configUrl String
    The base config URL of the DICOM Store instance
    defaultOrganizationId String
    The default organization ID
    dicomNotificationId String
    enabled Boolean
    Enable the notification or not. Default: true
    endpointUrl String
    The notification endpoint URL. Example: https://notification-dev.us-east.philips-healthsuite.com
    organizationId String

    Deprecated: Deprecated

    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