@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
303 lines • 13.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* 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](https://cloud.google.com/healthcare/docs/reference/rest/v1/projects.locations.datasets.dicomStores)
* * How-to Guides
* * [Creating a DICOM store](https://cloud.google.com/healthcare/docs/how-tos/dicom)
*
* ## Example Usage
*
* ### Healthcare Dicom Store Basic
*
* ```typescript
* 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",
* },
* });
* ```
* ### Healthcare Dicom Store Bq Stream
*
* ```typescript
* 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,
* sendForBulkImport: true,
* },
* labels: {
* label1: "labelvalue1",
* },
* streamConfigs: [{
* bigqueryDestination: {
* tableUri: pulumi.interpolate`bq://${bqDataset.project}.${bqDataset.datasetId}.${bqTable.tableId}`,
* },
* }],
* });
* ```
*
* ## 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:
*
* ```sh
* $ pulumi import gcp:healthcare/dicomStore:DicomStore default {{dataset}}/dicomStores/{{name}}
* $ pulumi import gcp:healthcare/dicomStore:DicomStore default {{dataset}}/{{name}}
* ```
*/
export declare class DicomStore extends pulumi.CustomResource {
/**
* Get an existing DicomStore resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DicomStoreState, opts?: pulumi.CustomResourceOptions): DicomStore;
/**
* Returns true if the given object is an instance of DicomStore. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DicomStore;
/**
* Identifies the dataset addressed by this request. Must be in the format
* 'projects/{project}/locations/{location}/datasets/{dataset}'
*/
readonly dataset: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[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 `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The resource name for the DicomStore.
* ** Changing this property may recreate the Dicom store (removing all data) **
*/
readonly name: pulumi.Output<string>;
/**
* A nested object resource.
* Structure is documented below.
*/
readonly notificationConfig: pulumi.Output<outputs.healthcare.DicomStoreNotificationConfig | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The fully qualified name of this dataset
*/
readonly selfLink: pulumi.Output<string>;
/**
* (Optional, Beta)
* 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.
*/
readonly streamConfigs: pulumi.Output<outputs.healthcare.DicomStoreStreamConfig[] | undefined>;
/**
* Create a DicomStore resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DicomStoreArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DicomStore resources.
*/
export interface DicomStoreState {
/**
* Identifies the dataset addressed by this request. Must be in the format
* 'projects/{project}/locations/{location}/datasets/{dataset}'
*/
dataset?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* 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 `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The resource name for the DicomStore.
* ** Changing this property may recreate the Dicom store (removing all data) **
*/
name?: pulumi.Input<string | undefined>;
/**
* A nested object resource.
* Structure is documented below.
*/
notificationConfig?: pulumi.Input<inputs.healthcare.DicomStoreNotificationConfig | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The fully qualified name of this dataset
*/
selfLink?: pulumi.Input<string | undefined>;
/**
* (Optional, Beta)
* 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.
*/
streamConfigs?: pulumi.Input<pulumi.Input<inputs.healthcare.DicomStoreStreamConfig>[] | undefined>;
}
/**
* The set of arguments for constructing a DicomStore resource.
*/
export interface DicomStoreArgs {
/**
* Identifies the dataset addressed by this request. Must be in the format
* 'projects/{project}/locations/{location}/datasets/{dataset}'
*/
dataset: pulumi.Input<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* 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 `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The resource name for the DicomStore.
* ** Changing this property may recreate the Dicom store (removing all data) **
*/
name?: pulumi.Input<string | undefined>;
/**
* A nested object resource.
* Structure is documented below.
*/
notificationConfig?: pulumi.Input<inputs.healthcare.DicomStoreNotificationConfig | undefined>;
/**
* (Optional, Beta)
* 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.
*/
streamConfigs?: pulumi.Input<pulumi.Input<inputs.healthcare.DicomStoreStreamConfig>[] | undefined>;
}
//# sourceMappingURL=dicomStore.d.ts.map