Package com.hashicorp.cdktf.providers.google.healthcare_fhir_store

Class HealthcareFhirStore.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static HealthcareFhirStore.Builder create​(software.constructs.Construct scope,
                                                 String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of HealthcareFhirStore.Builder.

      • connection

        @Stability(Experimental)
public HealthcareFhirStore.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public HealthcareFhirStore.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public HealthcareFhirStore.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public HealthcareFhirStore.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public HealthcareFhirStore.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public HealthcareFhirStore.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public HealthcareFhirStore.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public HealthcareFhirStore.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • dataset

        @Stability(Stable)
public HealthcareFhirStore.Builder dataset​(String dataset)
        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/5.43.1/docs/resources/healthcare_fhir_store#dataset HealthcareFhirStore#dataset}

        Parameters:
        dataset - Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public HealthcareFhirStore.Builder name​(String name)
        The resource name for the FhirStore.

        ** Changing this property may recreate the FHIR store (removing all data) ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#name HealthcareFhirStore#name}

        Parameters:
        name - The resource name for the FhirStore. This parameter is required.
        Returns:
        this

      • version

        @Stability(Stable)
public HealthcareFhirStore.Builder version​(String version)
        The FHIR specification version. Possible values: ["DSTU2", "STU3", "R4"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#version HealthcareFhirStore#version}

        Parameters:
        version - The FHIR specification version. Possible values: ["DSTU2", "STU3", "R4"]. This parameter is required.
        Returns:
        this

      • complexDataTypeReferenceParsing

        @Stability(Stable)
public HealthcareFhirStore.Builder complexDataTypeReferenceParsing​(String complexDataTypeReferenceParsing)
        Enable parsing of references within complex FHIR data types such as Extensions.

        If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. Possible values: ["COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED", "DISABLED", "ENABLED"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#complex_data_type_reference_parsing HealthcareFhirStore#complex_data_type_reference_parsing}

        Parameters:
        complexDataTypeReferenceParsing - Enable parsing of references within complex FHIR data types such as Extensions. This parameter is required.
        Returns:
        this

      • defaultSearchHandlingStrict

        @Stability(Stable)
public HealthcareFhirStore.Builder defaultSearchHandlingStrict​(Boolean defaultSearchHandlingStrict)
        If true, overrides the default search behavior for this FHIR store to handling=strict which returns an error for unrecognized search parameters.

        If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#default_search_handling_strict HealthcareFhirStore#default_search_handling_strict}

        Parameters:
        defaultSearchHandlingStrict - If true, overrides the default search behavior for this FHIR store to handling=strict which returns an error for unrecognized search parameters. This parameter is required.
        Returns:
        this

      • defaultSearchHandlingStrict

        @Stability(Stable)
public HealthcareFhirStore.Builder defaultSearchHandlingStrict​(com.hashicorp.cdktf.IResolvable defaultSearchHandlingStrict)
        If true, overrides the default search behavior for this FHIR store to handling=strict which returns an error for unrecognized search parameters.

        If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#default_search_handling_strict HealthcareFhirStore#default_search_handling_strict}

        Parameters:
        defaultSearchHandlingStrict - If true, overrides the default search behavior for this FHIR store to handling=strict which returns an error for unrecognized search parameters. This parameter is required.
        Returns:
        this

      • disableReferentialIntegrity

        @Stability(Stable)
public HealthcareFhirStore.Builder disableReferentialIntegrity​(Boolean disableReferentialIntegrity)
        Whether to disable referential integrity in this FHIR store.

        This field is immutable after FHIR store creation. The default value is false, meaning that the API will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as Patient.get$everything, will not return all the results if broken references exist. ** Changing this property may recreate the FHIR store (removing all data) ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#disable_referential_integrity HealthcareFhirStore#disable_referential_integrity}

        Parameters:
        disableReferentialIntegrity - Whether to disable referential integrity in this FHIR store. This parameter is required.
        Returns:
        this

      • disableReferentialIntegrity

        @Stability(Stable)
public HealthcareFhirStore.Builder disableReferentialIntegrity​(com.hashicorp.cdktf.IResolvable disableReferentialIntegrity)
        Whether to disable referential integrity in this FHIR store.

        This field is immutable after FHIR store creation. The default value is false, meaning that the API will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as Patient.get$everything, will not return all the results if broken references exist. ** Changing this property may recreate the FHIR store (removing all data) ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#disable_referential_integrity HealthcareFhirStore#disable_referential_integrity}

        Parameters:
        disableReferentialIntegrity - Whether to disable referential integrity in this FHIR store. This parameter is required.
        Returns:
        this

      • disableResourceVersioning

        @Stability(Stable)
public HealthcareFhirStore.Builder disableResourceVersioning​(Boolean disableResourceVersioning)
        Whether to disable resource versioning for this FHIR store.

        This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations will cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for attempts to read the historical versions. ** Changing this property may recreate the FHIR store (removing all data) ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#disable_resource_versioning HealthcareFhirStore#disable_resource_versioning}

        Parameters:
        disableResourceVersioning - Whether to disable resource versioning for this FHIR store. This parameter is required.
        Returns:
        this

      • disableResourceVersioning

        @Stability(Stable)
public HealthcareFhirStore.Builder disableResourceVersioning​(com.hashicorp.cdktf.IResolvable disableResourceVersioning)
        Whether to disable resource versioning for this FHIR store.

        This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations will cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions will be kept. The server will send back errors for attempts to read the historical versions. ** Changing this property may recreate the FHIR store (removing all data) ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#disable_resource_versioning HealthcareFhirStore#disable_resource_versioning}

        Parameters:
        disableResourceVersioning - Whether to disable resource versioning for this FHIR store. This parameter is required.
        Returns:
        this

      • enableHistoryImport

        @Stability(Stable)
public HealthcareFhirStore.Builder enableHistoryImport​(Boolean enableHistoryImport)
        Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store.

        Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. ** Changing this property may recreate the FHIR store (removing all data) ** ** This property can be changed manually in the Google Cloud Healthcare admin console without recreating the FHIR store ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#enable_history_import HealthcareFhirStore#enable_history_import}

        Parameters:
        enableHistoryImport - Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. This parameter is required.
        Returns:
        this

      • enableHistoryImport

        @Stability(Stable)
public HealthcareFhirStore.Builder enableHistoryImport​(com.hashicorp.cdktf.IResolvable enableHistoryImport)
        Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store.

        Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. ** Changing this property may recreate the FHIR store (removing all data) ** ** This property can be changed manually in the Google Cloud Healthcare admin console without recreating the FHIR store ** Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#enable_history_import HealthcareFhirStore#enable_history_import}

        Parameters:
        enableHistoryImport - Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. This parameter is required.
        Returns:
        this

      • enableUpdateCreate

        @Stability(Stable)
public HealthcareFhirStore.Builder enableUpdateCreate​(Boolean enableUpdateCreate)
        Whether this FHIR store has the updateCreate capability.

        This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#enable_update_create HealthcareFhirStore#enable_update_create}

        Parameters:
        enableUpdateCreate - Whether this FHIR store has the updateCreate capability. This parameter is required.
        Returns:
        this

      • enableUpdateCreate

        @Stability(Stable)
public HealthcareFhirStore.Builder enableUpdateCreate​(com.hashicorp.cdktf.IResolvable enableUpdateCreate)
        Whether this FHIR store has the updateCreate capability.

        This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to Update a non-existent resource will return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#enable_update_create HealthcareFhirStore#enable_update_create}

        Parameters:
        enableUpdateCreate - Whether this FHIR store has the updateCreate capability. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public HealthcareFhirStore.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#id HealthcareFhirStore#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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#id HealthcareFhirStore#id}. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public HealthcareFhirStore.Builder labels​(Map<String,​String> labels)
        User-supplied key-value pairs used to organize FHIR 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/5.43.1/docs/resources/healthcare_fhir_store#labels HealthcareFhirStore#labels}

        Parameters:
        labels - User-supplied key-value pairs used to organize FHIR stores. This parameter is required.
        Returns:
        this

      • notificationConfig

        @Stability(Stable)
public HealthcareFhirStore.Builder notificationConfig​(HealthcareFhirStoreNotificationConfig notificationConfig)
        notification_config block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#notification_config HealthcareFhirStore#notification_config}

        Parameters:
        notificationConfig - notification_config block. This parameter is required.
        Returns:
        this

      • notificationConfigs

        @Stability(Stable)
public HealthcareFhirStore.Builder notificationConfigs​(com.hashicorp.cdktf.IResolvable notificationConfigs)
        notification_configs block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#notification_configs HealthcareFhirStore#notification_configs}

        Parameters:
        notificationConfigs - notification_configs block. This parameter is required.
        Returns:
        this

      • notificationConfigs

        @Stability(Stable)
public HealthcareFhirStore.Builder notificationConfigs​(List<? extends HealthcareFhirStoreNotificationConfigs> notificationConfigs)
        notification_configs block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#notification_configs HealthcareFhirStore#notification_configs}

        Parameters:
        notificationConfigs - notification_configs block. This parameter is required.
        Returns:
        this

      • streamConfigs

        @Stability(Stable)
public HealthcareFhirStore.Builder streamConfigs​(com.hashicorp.cdktf.IResolvable streamConfigs)
        stream_configs block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#stream_configs HealthcareFhirStore#stream_configs}

        Parameters:
        streamConfigs - stream_configs block. This parameter is required.
        Returns:
        this

      • streamConfigs

        @Stability(Stable)
public HealthcareFhirStore.Builder streamConfigs​(List<? extends HealthcareFhirStoreStreamConfigs> streamConfigs)
        stream_configs block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#stream_configs HealthcareFhirStore#stream_configs}

        Parameters:
        streamConfigs - stream_configs block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public HealthcareFhirStore.Builder timeouts​(HealthcareFhirStoreTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/healthcare_fhir_store#timeouts HealthcareFhirStore#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this