Skip to content

Commit 1fa05ac

Browse files
author
Uddipaan Hazarika
committed
standardized property list
1 parent 66f7fd9 commit 1fa05ac

File tree

1 file changed

+75
-75
lines changed

1 file changed

+75
-75
lines changed

docs/resources/vdb.md

Lines changed: 75 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -63,73 +63,6 @@ resource "delphix_vdb" "vdb_name_provion_by_timestamp_with_hook" {
6363

6464
* `name` - (Optional) [Updatable] The unique name of the VDB. If empty, a name is randomly generated.
6565

66-
* `instance_name` - (Optional) The VDB's SID name (Oracle Only).
67-
68-
* `open_reset_logs` - (Optional) TRUE or FALSE value which determines whether to open the database after provision (Oracle Only).
69-
70-
* `online_log_size` - (Optional) The online log size in MB (Oracle Only).
71-
72-
* `online_log_groups` - (Optional) The number of online log groups (Oracle Only).
73-
74-
* `archive_log` - (Optional) TRUE or FALSE boolean to create a VDB in `archivelog` mode (Oracle Only).
75-
76-
* `new_dbid` - (Optional) [Updatable] TRUE or FALSE boolean to generate a new DB ID for the created VDB (Oracle Only).
77-
78-
* `listener_ids` - (Optional) [Updatable] The listener IDs for this provision operation. This is a list of listener ids. For eg: [ "listener-123", "listener-456" ] (Oracle Only).
79-
80-
* `file_mapping_rules` - (Optional) The VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.
81-
82-
* `unique_name` - (Optional) The VDB's db_unique_name (Oracle Only).
83-
84-
* `auxiliary_template_id` - (Optional) The ID of the configuration template to apply to the auxiliary container database (CDB). This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set. (Oracle Only)
85-
86-
* `cdb_id` - (Optional) The ID of the container database (CDB) to provision an Oracle Multitenant database into. If empty, a new vCDB will be provisioned. (Oracle only)
87-
88-
* `os_username` - (Optional) The name of the privileged user to run the provision operation (Oracle only).
89-
90-
* `os_password` - (Optional) The password of the privileged user to run the provision operation (Oracle only).
91-
92-
* `vcdb_tde_key_identifier` - (Optional) ID of the key created by the Continuous Data Engine. (Oracle Multitenant Only)
93-
94-
* `cdb_tde_keystore_password` - (Optional) [Updatable] The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
95-
96-
* `target_vcdb_tde_keystore_path` - (Optional) [Updatable] Path to the keystore of the vCDB. (Oracle Multitenant Only)
97-
98-
* `tde_key_identifier` - (Optional) [Updatable] ID of the key created by the Continuous Data Engine. (Oracle Multitenant Only)
99-
100-
* `tde_exported_key_file_secret` - (Optional) Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)
101-
102-
* `parent_tde_keystore_password` - (Optional) [Updatable] The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
103-
104-
* `parent_tde_keystore_path` - (Optional) [Updatable] Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
105-
106-
* `vcdb_name` - (Optional) The name of the provisioned vCDB when the cdb_id property is not set (Oracle Multitenant Only).
107-
108-
* `vcdb_database_name` - (Optional) The database name of the provisioned vCDB wwhen the cdb_id property is not set. Defaults to the value of the vcdb_name property (Oracle Multitenant Only).
109-
110-
* `cluster_node_ids` - (Optional) The cluster node ids, name, or addresses for this provision operation (Oracle RAC Only).
111-
112-
* `oracle_rac_custom_env_vars` - (Optional) Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
113-
* `node_id` - (Required) The node id of the cluster.
114-
* `name` - (Required) Name of the environment variable
115-
* `value` - (Required) Value of the environment variable.
116-
117-
* `oracle_rac_custom_env_files` - (Optional) Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
118-
* `node_id` - (Required) The node id of the cluster.
119-
* `path_parameters` - (Required) This references a file from which certain parameters will be loaded.
120-
121-
* `db_username` - (Optional) [Updatable] The username of the database (Oracle, SAP ASE only). Only for update.
122-
123-
* `db_password` - (Optional) [Updatable] The password of the database (Oracle, SAP ASE only). Only for update.
124-
125-
* `template_id` - (Optional) [Updatable] The ID of the VDB Configuration Template (Oracle, SQL Server Only).
126-
127-
* `database_name` - (Optional) The name of the database on the Target environment. Defaults to "name" (Oracle, MSSQL, SAP ASE).
128-
129-
* `mount_point` - (Optional) [Updatable] The mount point for the VDB (Oracle, ASE Only).
130-
131-
* `truncate_log_on_checkpoint` - (Optional) TRUE or FALSE value to truncate the logs on checkpoints (SAP ASE only).
132-
13366
* `environment_id` - (Optional) The ID or name of the Target environment where to provision the VDB. If "repository_id" unambigously identifies a repository, then this value is ignored.
13467

13568
* `environment_user_id` - (Optional) [Updatable] The environment user ID to use to connect to the Target environment.
@@ -199,14 +132,6 @@ resource "delphix_vdb" "vdb_name_provion_by_timestamp_with_hook" {
199132

200133
* `retention_policy_id` - (Optional) The ID of the Snapshot Retention Policy for the VDB.
201134

202-
* `recovery_model` - (Optional) Recovery model of the source database. Valid values are `[ FULL, SIMPLE, BULK_LOGGED ]` (SQL Server Only).
203-
204-
* `pre_script` - (Optional) [Updatable] PowerShell script or executable to run prior to provisioning (SQL Server Only).
205-
206-
* `post_script` - (Optional) [Updatable] PowerShell script or executable to run after provisioning (SQL Server Only).
207-
208-
* `cdc_on_provision` - (Optional) [Updatable] Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (SQL Server Only).
209-
210135
* `masked` - (Optional) TRUE or FALSE boolean to set a VDB as "Masked". Note: You should define a `configure_clone` script in the Hooks step to mask the dataset. The selection of this option will cause the data to be marked as masked, regardless of whether you have defined a script to do so or not.
211136
If you do not define a script to mask the dataset, the data will not be masked unless there is a masking job associated with the dataset.
212137

@@ -230,6 +155,81 @@ Environment variable to be set when a VDB is created. See the Continuous Data EN
230155
* `mount_path` - (Optional) Absolute path on the target environment were the filesystem should be mounted
231156
* `environment_id` - (Optional) The entity ID of the environment on which the file system will be mounted.
232157

158+
* `instance_name` - (Optional) The VDB's SID name (Oracle Only).
159+
160+
* `open_reset_logs` - (Optional) TRUE or FALSE value which determines whether to open the database after provision (Oracle Only).
161+
162+
* `online_log_size` - (Optional) The online log size in MB (Oracle Only).
163+
164+
* `online_log_groups` - (Optional) The number of online log groups (Oracle Only).
165+
166+
* `archive_log` - (Optional) TRUE or FALSE boolean to create a VDB in `archivelog` mode (Oracle Only).
167+
168+
* `new_dbid` - (Optional) [Updatable] TRUE or FALSE boolean to generate a new DB ID for the created VDB (Oracle Only).
169+
170+
* `listener_ids` - (Optional) [Updatable] The listener IDs for this provision operation. This is a list of listener ids. For eg: [ "listener-123", "listener-456" ] (Oracle Only).
171+
172+
* `file_mapping_rules` - (Optional) The VDB file mapping rules (Oracle Only). Rules must be line separated (\n or \r) and each line must have the format "pattern:replacement". Lines are applied in order.
173+
174+
* `unique_name` - (Optional) The VDB's db_unique_name (Oracle Only).
175+
176+
* `auxiliary_template_id` - (Optional) The ID of the configuration template to apply to the auxiliary container database (CDB). This is only relevant when provisioning a Multitenant pluggable database into an existing CDB, i.e when the cdb_id property is set. (Oracle Only)
177+
178+
* `cdb_id` - (Optional) The ID of the container database (CDB) to provision an Oracle Multitenant database into. If empty, a new vCDB will be provisioned. (Oracle only)
179+
180+
* `os_username` - (Optional) The name of the privileged user to run the provision operation (Oracle only).
181+
182+
* `os_password` - (Optional) The password of the privileged user to run the provision operation (Oracle only).
183+
184+
* `vcdb_tde_key_identifier` - (Optional) ID of the key created by the Continuous Data Engine. (Oracle Multitenant Only)
185+
186+
* `cdb_tde_keystore_password` - (Optional) [Updatable] The password for the Transparent Data Encryption keystore associated with the CDB. (Oracle Multitenant Only)
187+
188+
* `target_vcdb_tde_keystore_path` - (Optional) [Updatable] Path to the keystore of the vCDB. (Oracle Multitenant Only)
189+
190+
* `tde_key_identifier` - (Optional) [Updatable] ID of the key created by the Continuous Data Engine. (Oracle Multitenant Only)
191+
192+
* `tde_exported_key_file_secret` - (Optional) Secret to be used while exporting and importing vPDB encryption keys if Transparent Data Encryption is enabled on the vPDB. (Oracle Multitenant Only)
193+
194+
* `parent_tde_keystore_password` - (Optional) [Updatable] The password of the keystore specified in parentTdeKeystorePath. (Oracle Multitenant Only)
195+
196+
* `parent_tde_keystore_path` - (Optional) [Updatable] Path to a copy of the parent's Oracle transparent data encryption keystore on the target host. Required to provision from snapshots containing encrypted database files. (Oracle Multitenant Only)
197+
198+
* `vcdb_name` - (Optional) The name of the provisioned vCDB when the cdb_id property is not set (Oracle Multitenant Only).
199+
200+
* `vcdb_database_name` - (Optional) The database name of the provisioned vCDB wwhen the cdb_id property is not set. Defaults to the value of the vcdb_name property (Oracle Multitenant Only).
201+
202+
* `cluster_node_ids` - (Optional) The cluster node ids, name, or addresses for this provision operation (Oracle RAC Only).
203+
204+
* `oracle_rac_custom_env_vars` - (Optional) Environment variable to be set when the engine creates an Oracle RAC VDB. See the Engine documentation for the list of allowed/denied environment variables and rules about substitution.
205+
* `node_id` - (Required) The node id of the cluster.
206+
* `name` - (Required) Name of the environment variable
207+
* `value` - (Required) Value of the environment variable.
208+
209+
* `oracle_rac_custom_env_files` - (Optional) Environment files to be sourced when the Engine creates an Oracle RAC VDB. This path can be followed by parameters. Paths and parameters are separated by spaces.
210+
* `node_id` - (Required) The node id of the cluster.
211+
* `path_parameters` - (Required) This references a file from which certain parameters will be loaded.
212+
213+
* `db_username` - (Optional) [Updatable] The username of the database (Oracle, SAP ASE only). Only for update.
214+
215+
* `db_password` - (Optional) [Updatable] The password of the database (Oracle, SAP ASE only). Only for update.
216+
217+
* `template_id` - (Optional) [Updatable] The ID of the VDB Configuration Template (Oracle, SQL Server Only).
218+
219+
* `database_name` - (Optional) The name of the database on the Target environment. Defaults to "name" (Oracle, MSSQL, SAP ASE).
220+
221+
* `mount_point` - (Optional) [Updatable] The mount point for the VDB (Oracle, ASE Only).
222+
223+
* `truncate_log_on_checkpoint` - (Optional) TRUE or FALSE value to truncate the logs on checkpoints (SAP ASE only).
224+
225+
* `recovery_model` - (Optional) Recovery model of the source database. Valid values are `[ FULL, SIMPLE, BULK_LOGGED ]` (SQL Server Only).
226+
227+
* `pre_script` - (Optional) [Updatable] PowerShell script or executable to run prior to provisioning (SQL Server Only).
228+
229+
* `post_script` - (Optional) [Updatable] PowerShell script or executable to run after provisioning (SQL Server Only).
230+
231+
* `cdc_on_provision` - (Optional) [Updatable] Option to enable change data capture (CDC) on both the provisioned VDB and subsequent snapshot-related operations (e.g. refresh, rewind) (SQL Server Only).
232+
233233

234234
## Attribute Reference
235235

0 commit comments

Comments
 (0)