@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
279 lines • 12.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The Consent Management API is a tool for tracking user consents and the documentation associated with the consents.
*
* To get more information about ConsentStore, see:
*
* * [API documentation](https://cloud.google.com/healthcare/docs/reference/rest/v1/projects.locations.datasets.consentStores)
* * How-to Guides
* * [Creating a Consent store](https://cloud.google.com/healthcare/docs/how-tos/consent)
*
* ## Example Usage
*
* ### Healthcare Consent Store Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.healthcare.Dataset("dataset", {
* location: "us-central1",
* name: "my-dataset",
* });
* const my_consent = new gcp.healthcare.ConsentStore("my-consent", {
* dataset: dataset.id,
* name: "my-consent-store",
* });
* ```
* ### Healthcare Consent Store Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.healthcare.Dataset("dataset", {
* location: "us-central1",
* name: "my-dataset",
* });
* const my_consent = new gcp.healthcare.ConsentStore("my-consent", {
* dataset: dataset.id,
* name: "my-consent-store",
* enableConsentCreateOnUpdate: true,
* defaultConsentTtl: "90000s",
* labels: {
* label1: "labelvalue1",
* },
* });
* ```
* ### Healthcare Consent Store Iam
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.healthcare.Dataset("dataset", {
* location: "us-central1",
* name: "my-dataset",
* });
* const my_consent = new gcp.healthcare.ConsentStore("my-consent", {
* dataset: dataset.id,
* name: "my-consent-store",
* });
* const test_account = new gcp.serviceaccount.Account("test-account", {
* accountId: "my-account",
* displayName: "Test Service Account",
* });
* const test_iam = new gcp.healthcare.ConsentStoreIamMember("test-iam", {
* dataset: dataset.id,
* consentStoreId: my_consent.name,
* role: "roles/editor",
* member: pulumi.interpolate`serviceAccount:${test_account.email}`,
* });
* ```
*
* ## Import
*
* ConsentStore can be imported using any of these accepted formats:
*
* * `{{dataset}}/consentStores/{{name}}`
*
* When using the `pulumi import` command, ConsentStore can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:healthcare/consentStore:ConsentStore default {{dataset}}/consentStores/{{name}}
* ```
*/
export declare class ConsentStore extends pulumi.CustomResource {
/**
* Get an existing ConsentStore 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?: ConsentStoreState, opts?: pulumi.CustomResourceOptions): ConsentStore;
/**
* Returns true if the given object is an instance of ConsentStore. 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 ConsentStore;
/**
* Identifies the dataset addressed by this request. Must be in the format
* 'projects/{project}/locations/{location}/datasets/{dataset}'
*/
readonly dataset: pulumi.Output<string>;
/**
* Default time to live for consents in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
* A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
*/
readonly defaultConsentTtl: pulumi.Output<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.
*/
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;
}>;
/**
* If true, [consents.patch] [google.cloud.healthcare.v1.consent.UpdateConsent] creates the consent if it does not already exist.
*/
readonly enableConsentCreateOnUpdate: pulumi.Output<boolean | undefined>;
/**
* User-supplied key-value pairs used to organize Consent 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 name of this ConsentStore, for example:
* "consent1"
*/
readonly name: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a ConsentStore 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: ConsentStoreArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConsentStore resources.
*/
export interface ConsentStoreState {
/**
* Identifies the dataset addressed by this request. Must be in the format
* 'projects/{project}/locations/{location}/datasets/{dataset}'
*/
dataset?: pulumi.Input<string | undefined>;
/**
* Default time to live for consents in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
* A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
*/
defaultConsentTtl?: 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>;
/**
* If true, [consents.patch] [google.cloud.healthcare.v1.consent.UpdateConsent] creates the consent if it does not already exist.
*/
enableConsentCreateOnUpdate?: pulumi.Input<boolean | undefined>;
/**
* User-supplied key-value pairs used to organize Consent 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 name of this ConsentStore, for example:
* "consent1"
*/
name?: pulumi.Input<string | 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 set of arguments for constructing a ConsentStore resource.
*/
export interface ConsentStoreArgs {
/**
* Identifies the dataset addressed by this request. Must be in the format
* 'projects/{project}/locations/{location}/datasets/{dataset}'
*/
dataset: pulumi.Input<string>;
/**
* Default time to live for consents in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
* A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
*/
defaultConsentTtl?: 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>;
/**
* If true, [consents.patch] [google.cloud.healthcare.v1.consent.UpdateConsent] creates the consent if it does not already exist.
*/
enableConsentCreateOnUpdate?: pulumi.Input<boolean | undefined>;
/**
* User-supplied key-value pairs used to organize Consent 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 name of this ConsentStore, for example:
* "consent1"
*/
name?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=consentStore.d.ts.map