@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
215 lines (214 loc) • 11.2 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface HealthcareDicomStoreConfig extends cdktf.TerraformMetaArguments {
/**
* Identifies the dataset addressed by this request. Must be in the format
* 'projects/{project}/locations/{location}/datasets/{dataset}'
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#dataset HealthcareDicomStore#dataset}
*/
readonly dataset: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#id HealthcareDicomStore#id}
*
* Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
* If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
*/
readonly id?: 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.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#labels HealthcareDicomStore#labels}
*/
readonly labels?: {
[key: string]: string;
};
/**
* The resource name for the DicomStore.
*
* ** Changing this property may recreate the Dicom store (removing all data) **
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#name HealthcareDicomStore#name}
*/
readonly name: string;
/**
* notification_config block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#notification_config HealthcareDicomStore#notification_config}
*/
readonly notificationConfig?: HealthcareDicomStoreNotificationConfig;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#timeouts HealthcareDicomStore#timeouts}
*/
readonly timeouts?: HealthcareDicomStoreTimeouts;
}
export interface HealthcareDicomStoreNotificationConfig {
/**
* 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.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#pubsub_topic HealthcareDicomStore#pubsub_topic}
*/
readonly pubsubTopic: string;
/**
* Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#send_for_bulk_import HealthcareDicomStore#send_for_bulk_import}
*/
readonly sendForBulkImport?: boolean | cdktf.IResolvable;
}
export declare function healthcareDicomStoreNotificationConfigToTerraform(struct?: HealthcareDicomStoreNotificationConfigOutputReference | HealthcareDicomStoreNotificationConfig): any;
export declare function healthcareDicomStoreNotificationConfigToHclTerraform(struct?: HealthcareDicomStoreNotificationConfigOutputReference | HealthcareDicomStoreNotificationConfig): any;
export declare class HealthcareDicomStoreNotificationConfigOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): HealthcareDicomStoreNotificationConfig | undefined;
set internalValue(value: HealthcareDicomStoreNotificationConfig | undefined);
private _pubsubTopic?;
get pubsubTopic(): string;
set pubsubTopic(value: string);
get pubsubTopicInput(): string | undefined;
private _sendForBulkImport?;
get sendForBulkImport(): boolean | cdktf.IResolvable;
set sendForBulkImport(value: boolean | cdktf.IResolvable);
resetSendForBulkImport(): void;
get sendForBulkImportInput(): boolean | cdktf.IResolvable | undefined;
}
export interface HealthcareDicomStoreTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#create HealthcareDicomStore#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#delete HealthcareDicomStore#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#update HealthcareDicomStore#update}
*/
readonly update?: string;
}
export declare function healthcareDicomStoreTimeoutsToTerraform(struct?: HealthcareDicomStoreTimeouts | cdktf.IResolvable): any;
export declare function healthcareDicomStoreTimeoutsToHclTerraform(struct?: HealthcareDicomStoreTimeouts | cdktf.IResolvable): any;
export declare class HealthcareDicomStoreTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): HealthcareDicomStoreTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: HealthcareDicomStoreTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store google_healthcare_dicom_store}
*/
export declare class HealthcareDicomStore extends cdktf.TerraformResource {
static readonly tfResourceType = "google_healthcare_dicom_store";
/**
* Generates CDKTF code for importing a HealthcareDicomStore resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the HealthcareDicomStore to import
* @param importFromId The id of the existing HealthcareDicomStore that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the HealthcareDicomStore to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/healthcare_dicom_store google_healthcare_dicom_store} Resource
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options HealthcareDicomStoreConfig
*/
constructor(scope: Construct, id: string, config: HealthcareDicomStoreConfig);
private _dataset?;
get dataset(): string;
set dataset(value: string);
get datasetInput(): string | undefined;
private _effectiveLabels;
get effectiveLabels(): cdktf.StringMap;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _labels?;
get labels(): {
[key: string]: string;
};
set labels(value: {
[key: string]: string;
});
resetLabels(): void;
get labelsInput(): {
[key: string]: string;
} | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
get selfLink(): string;
private _terraformLabels;
get terraformLabels(): cdktf.StringMap;
private _notificationConfig;
get notificationConfig(): HealthcareDicomStoreNotificationConfigOutputReference;
putNotificationConfig(value: HealthcareDicomStoreNotificationConfig): void;
resetNotificationConfig(): void;
get notificationConfigInput(): HealthcareDicomStoreNotificationConfig | undefined;
private _timeouts;
get timeouts(): HealthcareDicomStoreTimeoutsOutputReference;
putTimeouts(value: HealthcareDicomStoreTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | HealthcareDicomStoreTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}