CreateDatabaseDetails¶

class oci.database.models.CreateDatabaseDetails(**kwargs)¶

Bases: object

Details for creating a database.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`DB_WORKLOAD_DSS`	A constant which can be used with the db_workload property of a CreateDatabaseDetails.
`DB_WORKLOAD_OLTP`	A constant which can be used with the db_workload property of a CreateDatabaseDetails.
`admin_password`	[Required] Gets the admin_password of this CreateDatabaseDetails.
`character_set`	Gets the character_set of this CreateDatabaseDetails.
`database_software_image_id`	Gets the database_software_image_id of this CreateDatabaseDetails.
`db_backup_config`	Gets the db_backup_config of this CreateDatabaseDetails.
`db_name`	[Required] Gets the db_name of this CreateDatabaseDetails.
`db_unique_name`	Gets the db_unique_name of this CreateDatabaseDetails.
`db_workload`	Gets the db_workload of this CreateDatabaseDetails.
`defined_tags`	Gets the defined_tags of this CreateDatabaseDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDatabaseDetails.
`key_store_id`	Gets the key_store_id of this CreateDatabaseDetails.
`kms_key_id`	Gets the kms_key_id of this CreateDatabaseDetails.
`kms_key_version_id`	Gets the kms_key_version_id of this CreateDatabaseDetails.
`ncharacter_set`	Gets the ncharacter_set of this CreateDatabaseDetails.
`pdb_name`	Gets the pdb_name of this CreateDatabaseDetails.
`sid_prefix`	Gets the sid_prefix of this CreateDatabaseDetails.
`tde_wallet_password`	Gets the tde_wallet_password of this CreateDatabaseDetails.
`vault_id`	Gets the vault_id of this CreateDatabaseDetails.

Methods

__init__(**kwargs) Initializes a new CreateDatabaseDetails object with values from keyword arguments.

DB_WORKLOAD_DSS = 'DSS'¶: A constant which can be used with the db_workload property of a CreateDatabaseDetails. This constant has a value of “DSS”

DB_WORKLOAD_OLTP = 'OLTP'¶: A constant which can be used with the db_workload property of a CreateDatabaseDetails. This constant has a value of “OLTP”

__init__(**kwargs)¶

Initializes a new CreateDatabaseDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

db_name (str) – The value to assign to the db_name property of this CreateDatabaseDetails.
db_unique_name (str) – The value to assign to the db_unique_name property of this CreateDatabaseDetails.
database_software_image_id (str) – The value to assign to the database_software_image_id property of this CreateDatabaseDetails.
pdb_name (str) – The value to assign to the pdb_name property of this CreateDatabaseDetails.
admin_password (str) – The value to assign to the admin_password property of this CreateDatabaseDetails.
tde_wallet_password (str) – The value to assign to the tde_wallet_password property of this CreateDatabaseDetails.
character_set (str) – The value to assign to the character_set property of this CreateDatabaseDetails.
ncharacter_set (str) – The value to assign to the ncharacter_set property of this CreateDatabaseDetails.
db_workload (str) – The value to assign to the db_workload property of this CreateDatabaseDetails. Allowed values for this property are: “OLTP”, “DSS”
db_backup_config (oci.database.models.DbBackupConfig) – The value to assign to the db_backup_config property of this CreateDatabaseDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDatabaseDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDatabaseDetails.
kms_key_id (str) – The value to assign to the kms_key_id property of this CreateDatabaseDetails.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this CreateDatabaseDetails.
vault_id (str) – The value to assign to the vault_id property of this CreateDatabaseDetails.
sid_prefix (str) – The value to assign to the sid_prefix property of this CreateDatabaseDetails.
key_store_id (str) – The value to assign to the key_store_id property of this CreateDatabaseDetails.

admin_password¶

[Required] Gets the admin_password of this CreateDatabaseDetails. A strong password for SYS, SYSTEM, and PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.

Returns:	The admin_password of this CreateDatabaseDetails.
Return type:	str

character_set¶

Gets the character_set of this CreateDatabaseDetails. The character set for the database. The default is AL32UTF8. Allowed values are:

AL32UTF8, AR8ADOS710, AR8ADOS720, AR8APTEC715, AR8ARABICMACS, AR8ASMO8X, AR8ISO8859P6, AR8MSWIN1256, AR8MUSSAD768, AR8NAFITHA711, AR8NAFITHA721, AR8SAKHR706, AR8SAKHR707, AZ8ISO8859P9E, BG8MSWIN, BG8PC437S, BLT8CP921, BLT8ISO8859P13, BLT8MSWIN1257, BLT8PC775, BN8BSCII, CDN8PC863, CEL8ISO8859P14, CL8ISO8859P5, CL8ISOIR111, CL8KOI8R, CL8KOI8U, CL8MACCYRILLICS, CL8MSWIN1251, EE8ISO8859P2, EE8MACCES, EE8MACCROATIANS, EE8MSWIN1250, EE8PC852, EL8DEC, EL8ISO8859P7, EL8MACGREEKS, EL8MSWIN1253, EL8PC437S, EL8PC851, EL8PC869, ET8MSWIN923, HU8ABMOD, HU8CWI2, IN8ISCII, IS8PC861, IW8ISO8859P8, IW8MACHEBREWS, IW8MSWIN1255, IW8PC1507, JA16EUC, JA16EUCTILDE, JA16SJIS, JA16SJISTILDE, JA16VMS, KO16KSC5601, KO16KSCCS, KO16MSWIN949, LA8ISO6937, LA8PASSPORT, LT8MSWIN921, LT8PC772, LT8PC774, LV8PC1117, LV8PC8LR, LV8RST104090, N8PC865, NE8ISO8859P10, NEE8ISO8859P4, RU8BESTA, RU8PC855, RU8PC866, SE8ISO8859P3, TH8MACTHAIS, TH8TISASCII, TR8DEC, TR8MACTURKISHS, TR8MSWIN1254, TR8PC857, US7ASCII, US8PC437, UTF8, VN8MSWIN1258, VN8VN3, WE8DEC, WE8DG, WE8ISO8859P1, WE8ISO8859P15, WE8ISO8859P9, WE8MACROMAN8S, WE8MSWIN1252, WE8NCR4970, WE8NEXTSTEP, WE8PC850, WE8PC858, WE8PC860, WE8ROMAN8, ZHS16CGB231280, ZHS16GBK, ZHT16BIG5, ZHT16CCDC, ZHT16DBT, ZHT16HKSCS, ZHT16MSWIN950, ZHT32EUC, ZHT32SOPS, ZHT32TRIS

Returns:	The character_set of this CreateDatabaseDetails.
Return type:	str

database_software_image_id¶

Gets the database_software_image_id of this CreateDatabaseDetails. The database software image OCID

Returns:	The database_software_image_id of this CreateDatabaseDetails.
Return type:	str

db_backup_config¶

Gets the db_backup_config of this CreateDatabaseDetails.

Returns:	The db_backup_config of this CreateDatabaseDetails.
Return type:	oci.database.models.DbBackupConfig

db_name¶

[Required] Gets the db_name of this CreateDatabaseDetails. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.

Returns:	The db_name of this CreateDatabaseDetails.
Return type:	str

db_unique_name¶

Gets the db_unique_name of this CreateDatabaseDetails. The DB_UNIQUE_NAME of the Oracle Database being backed up.

Returns:	The db_unique_name of this CreateDatabaseDetails.
Return type:	str

db_workload¶

Gets the db_workload of this CreateDatabaseDetails. Deprecated. The dbWorkload field has been deprecated for Exadata Database Service on Dedicated Infrastructure, Exadata Database Service on Cloud@Customer, and Base Database Service. Support for this attribute will end in November 2023. You may choose to update your custom scripts to exclude the dbWorkload attribute. After November 2023 if you pass a value to the dbWorkload attribute, it will be ignored.

The database workload type.

Allowed values for this property are: “OLTP”, “DSS”

Returns:	The db_workload of this CreateDatabaseDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateDatabaseDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:	The defined_tags of this CreateDatabaseDetails.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this CreateDatabaseDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this CreateDatabaseDetails.
Return type:	dict(str, str)

key_store_id¶

Gets the key_store_id of this CreateDatabaseDetails. The OCID of the key store of Oracle Vault.

Returns:	The key_store_id of this CreateDatabaseDetails.
Return type:	str

kms_key_id¶

Gets the kms_key_id of this CreateDatabaseDetails. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:	The kms_key_id of this CreateDatabaseDetails.
Return type:	str

kms_key_version_id¶

Gets the kms_key_version_id of this CreateDatabaseDetails. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

Returns:	The kms_key_version_id of this CreateDatabaseDetails.
Return type:	str

ncharacter_set¶

Gets the ncharacter_set of this CreateDatabaseDetails. The national character set for the database. The default is AL16UTF16. Allowed values are: AL16UTF16 or UTF8.

Returns:	The ncharacter_set of this CreateDatabaseDetails.
Return type:	str

pdb_name¶

Gets the pdb_name of this CreateDatabaseDetails. The name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.

Returns:	The pdb_name of this CreateDatabaseDetails.
Return type:	str

sid_prefix¶

Gets the sid_prefix of this CreateDatabaseDetails. Specifies a prefix for the Oracle SID of the database to be created.

Returns:	The sid_prefix of this CreateDatabaseDetails.
Return type:	str

tde_wallet_password¶

Gets the tde_wallet_password of this CreateDatabaseDetails. The optional password to open the TDE wallet. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numeric, and two special characters. The special characters must be _, #, or -.

Returns:	The tde_wallet_password of this CreateDatabaseDetails.
Return type:	str

vault_id¶

Gets the vault_id of this CreateDatabaseDetails. The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

Returns:	The vault_id of this CreateDatabaseDetails.
Return type:	str