1. Packages
  2. Google Cloud Native
  3. API Docs
  4. healthcare
  5. healthcare/v1beta1
  6. ConsentStore

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.healthcare/v1beta1.ConsentStore

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error.

Create ConsentStore Resource

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

Constructor syntax

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

@overload
def ConsentStore(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 consent_store_id: Optional[str] = None,
                 dataset_id: Optional[str] = None,
                 default_consent_ttl: Optional[str] = None,
                 enable_consent_create_on_update: Optional[bool] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None)
func NewConsentStore(ctx *Context, name string, args ConsentStoreArgs, opts ...ResourceOption) (*ConsentStore, error)
public ConsentStore(string name, ConsentStoreArgs args, CustomResourceOptions? opts = null)
public ConsentStore(String name, ConsentStoreArgs args)
public ConsentStore(String name, ConsentStoreArgs args, CustomResourceOptions options)
type: google-native:healthcare/v1beta1:ConsentStore
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. ConsentStoreArgs
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. ConsentStoreArgs
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. ConsentStoreArgs
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. ConsentStoreArgs
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. ConsentStoreArgs
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 google_nativeConsentStoreResource = new GoogleNative.Healthcare.V1Beta1.ConsentStore("google-nativeConsentStoreResource", new()
{
    ConsentStoreId = "string",
    DatasetId = "string",
    DefaultConsentTtl = "string",
    EnableConsentCreateOnUpdate = false,
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
});
Copy
example, err := healthcarev1beta1.NewConsentStore(ctx, "google-nativeConsentStoreResource", &healthcarev1beta1.ConsentStoreArgs{
	ConsentStoreId:              pulumi.String("string"),
	DatasetId:                   pulumi.String("string"),
	DefaultConsentTtl:           pulumi.String("string"),
	EnableConsentCreateOnUpdate: pulumi.Bool(false),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
})
Copy
var google_nativeConsentStoreResource = new ConsentStore("google-nativeConsentStoreResource", ConsentStoreArgs.builder()
    .consentStoreId("string")
    .datasetId("string")
    .defaultConsentTtl("string")
    .enableConsentCreateOnUpdate(false)
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .build());
Copy
google_native_consent_store_resource = google_native.healthcare.v1beta1.ConsentStore("google-nativeConsentStoreResource",
    consent_store_id="string",
    dataset_id="string",
    default_consent_ttl="string",
    enable_consent_create_on_update=False,
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string")
Copy
const google_nativeConsentStoreResource = new google_native.healthcare.v1beta1.ConsentStore("google-nativeConsentStoreResource", {
    consentStoreId: "string",
    datasetId: "string",
    defaultConsentTtl: "string",
    enableConsentCreateOnUpdate: false,
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
});
Copy
type: google-native:healthcare/v1beta1:ConsentStore
properties:
    consentStoreId: string
    datasetId: string
    defaultConsentTtl: string
    enableConsentCreateOnUpdate: false
    labels:
        string: string
    location: string
    name: string
    project: string
Copy

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

ConsentStoreId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID of the consent store to create. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}. Cannot be changed after creation.
DatasetId
This property is required.
Changes to this property will trigger replacement.
string
DefaultConsentTtl string
Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
EnableConsentCreateOnUpdate bool
Optional. If true, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to false.
Labels Dictionary<string, string>
Optional. 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}{0,62}. Label values 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. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
Location Changes to this property will trigger replacement. string
Name string
Resource name of the consent store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. Cannot be changed after creation.
Project Changes to this property will trigger replacement. string
ConsentStoreId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID of the consent store to create. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}. Cannot be changed after creation.
DatasetId
This property is required.
Changes to this property will trigger replacement.
string
DefaultConsentTtl string
Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
EnableConsentCreateOnUpdate bool
Optional. If true, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to false.
Labels map[string]string
Optional. 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}{0,62}. Label values 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. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
Location Changes to this property will trigger replacement. string
Name string
Resource name of the consent store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. Cannot be changed after creation.
Project Changes to this property will trigger replacement. string
consentStoreId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID of the consent store to create. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}. Cannot be changed after creation.
datasetId
This property is required.
Changes to this property will trigger replacement.
String
defaultConsentTtl String
Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
enableConsentCreateOnUpdate Boolean
Optional. If true, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to false.
labels Map<String,String>
Optional. 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}{0,62}. Label values 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. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
location Changes to this property will trigger replacement. String
name String
Resource name of the consent store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. Cannot be changed after creation.
project Changes to this property will trigger replacement. String
consentStoreId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID of the consent store to create. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}. Cannot be changed after creation.
datasetId
This property is required.
Changes to this property will trigger replacement.
string
defaultConsentTtl string
Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
enableConsentCreateOnUpdate boolean
Optional. If true, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to false.
labels {[key: string]: string}
Optional. 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}{0,62}. Label values 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. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
location Changes to this property will trigger replacement. string
name string
Resource name of the consent store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. Cannot be changed after creation.
project Changes to this property will trigger replacement. string
consent_store_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The ID of the consent store to create. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}. Cannot be changed after creation.
dataset_id
This property is required.
Changes to this property will trigger replacement.
str
default_consent_ttl str
Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
enable_consent_create_on_update bool
Optional. If true, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to false.
labels Mapping[str, str]
Optional. 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}{0,62}. Label values 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. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
location Changes to this property will trigger replacement. str
name str
Resource name of the consent store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. Cannot be changed after creation.
project Changes to this property will trigger replacement. str
consentStoreId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID of the consent store to create. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}. Cannot be changed after creation.
datasetId
This property is required.
Changes to this property will trigger replacement.
String
defaultConsentTtl String
Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents.
enableConsentCreateOnUpdate Boolean
Optional. If true, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to false.
labels Map<String>
Optional. 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}{0,62}. Label values 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. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
location Changes to this property will trigger replacement. String
name String
Resource name of the consent store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}. Cannot be changed after creation.
project Changes to this property will trigger replacement. String

Outputs

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

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi