Docs Home
oci.Database.PluggableDatabase
Explore with Pulumi AI
This resource provides the Pluggable Database resource in Oracle Cloud Infrastructure Database service.
Creates and starts a pluggable database in the specified container database. Pluggable Database can be created using different operations (e.g. LocalClone, RemoteClone, Relocate ) with this API. Use the StartPluggableDatabase and StopPluggableDatabase APIs to start and stop the pluggable database.
Create PluggableDatabase Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PluggableDatabase(name: string, args: PluggableDatabaseArgs, opts?: CustomResourceOptions);@overload
def PluggableDatabase(resource_name: str,
args: PluggableDatabaseArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PluggableDatabase(resource_name: str,
opts: Optional[ResourceOptions] = None,
pdb_name: Optional[str] = None,
container_database_id: Optional[str] = None,
pdb_admin_password: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
kms_key_version_id: Optional[str] = None,
container_database_admin_password: Optional[str] = None,
pdb_creation_type_details: Optional[_database.PluggableDatabasePdbCreationTypeDetailsArgs] = None,
convert_to_regular_trigger: Optional[int] = None,
refresh_trigger: Optional[int] = None,
rotate_key_trigger: Optional[int] = None,
should_create_pdb_backup: Optional[bool] = None,
should_pdb_admin_account_be_locked: Optional[bool] = None,
tde_wallet_password: Optional[str] = None)func NewPluggableDatabase(ctx *Context, name string, args PluggableDatabaseArgs, opts ...ResourceOption) (*PluggableDatabase, error)public PluggableDatabase(string name, PluggableDatabaseArgs args, CustomResourceOptions? opts = null)
public PluggableDatabase(String name, PluggableDatabaseArgs args)
public PluggableDatabase(String name, PluggableDatabaseArgs args, CustomResourceOptions options)
type: oci:Database:PluggableDatabase
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PluggableDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PluggableDatabaseArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PluggableDatabaseArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PluggableDatabaseArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PluggableDatabaseArgs
- 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 pluggableDatabaseResource = new Oci.Database.PluggableDatabase("pluggableDatabaseResource", new()
{
PdbName = "string",
ContainerDatabaseId = "string",
PdbAdminPassword = "string",
DefinedTags =
{
{ "string", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
KmsKeyVersionId = "string",
ContainerDatabaseAdminPassword = "string",
PdbCreationTypeDetails = new Oci.Database.Inputs.PluggableDatabasePdbCreationTypeDetailsArgs
{
CreationType = "string",
SourcePluggableDatabaseId = "string",
DblinkUserPassword = "string",
DblinkUsername = "string",
IsThinClone = false,
RefreshableCloneDetails = new Oci.Database.Inputs.PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetailsArgs
{
IsRefreshableClone = false,
},
SourceContainerDatabaseAdminPassword = "string",
},
ConvertToRegularTrigger = 0,
RefreshTrigger = 0,
RotateKeyTrigger = 0,
ShouldCreatePdbBackup = false,
ShouldPdbAdminAccountBeLocked = false,
TdeWalletPassword = "string",
});
example, err := Database.NewPluggableDatabase(ctx, "pluggableDatabaseResource", &Database.PluggableDatabaseArgs{
PdbName: pulumi.String("string"),
ContainerDatabaseId: pulumi.String("string"),
PdbAdminPassword: pulumi.String("string"),
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
KmsKeyVersionId: pulumi.String("string"),
ContainerDatabaseAdminPassword: pulumi.String("string"),
PdbCreationTypeDetails: &database.PluggableDatabasePdbCreationTypeDetailsArgs{
CreationType: pulumi.String("string"),
SourcePluggableDatabaseId: pulumi.String("string"),
DblinkUserPassword: pulumi.String("string"),
DblinkUsername: pulumi.String("string"),
IsThinClone: pulumi.Bool(false),
RefreshableCloneDetails: &database.PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetailsArgs{
IsRefreshableClone: pulumi.Bool(false),
},
SourceContainerDatabaseAdminPassword: pulumi.String("string"),
},
ConvertToRegularTrigger: pulumi.Int(0),
RefreshTrigger: pulumi.Int(0),
RotateKeyTrigger: pulumi.Int(0),
ShouldCreatePdbBackup: pulumi.Bool(false),
ShouldPdbAdminAccountBeLocked: pulumi.Bool(false),
TdeWalletPassword: pulumi.String("string"),
})
var pluggableDatabaseResource = new PluggableDatabase("pluggableDatabaseResource", PluggableDatabaseArgs.builder()
.pdbName("string")
.containerDatabaseId("string")
.pdbAdminPassword("string")
.definedTags(Map.of("string", "string"))
.freeformTags(Map.of("string", "string"))
.kmsKeyVersionId("string")
.containerDatabaseAdminPassword("string")
.pdbCreationTypeDetails(PluggableDatabasePdbCreationTypeDetailsArgs.builder()
.creationType("string")
.sourcePluggableDatabaseId("string")
.dblinkUserPassword("string")
.dblinkUsername("string")
.isThinClone(false)
.refreshableCloneDetails(PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetailsArgs.builder()
.isRefreshableClone(false)
.build())
.sourceContainerDatabaseAdminPassword("string")
.build())
.convertToRegularTrigger(0)
.refreshTrigger(0)
.rotateKeyTrigger(0)
.shouldCreatePdbBackup(false)
.shouldPdbAdminAccountBeLocked(false)
.tdeWalletPassword("string")
.build());
pluggable_database_resource = oci.database.PluggableDatabase("pluggableDatabaseResource",
pdb_name="string",
container_database_id="string",
pdb_admin_password="string",
defined_tags={
"string": "string",
},
freeform_tags={
"string": "string",
},
kms_key_version_id="string",
container_database_admin_password="string",
pdb_creation_type_details={
"creation_type": "string",
"source_pluggable_database_id": "string",
"dblink_user_password": "string",
"dblink_username": "string",
"is_thin_clone": False,
"refreshable_clone_details": {
"is_refreshable_clone": False,
},
"source_container_database_admin_password": "string",
},
convert_to_regular_trigger=0,
refresh_trigger=0,
rotate_key_trigger=0,
should_create_pdb_backup=False,
should_pdb_admin_account_be_locked=False,
tde_wallet_password="string")
const pluggableDatabaseResource = new oci.database.PluggableDatabase("pluggableDatabaseResource", {
pdbName: "string",
containerDatabaseId: "string",
pdbAdminPassword: "string",
definedTags: {
string: "string",
},
freeformTags: {
string: "string",
},
kmsKeyVersionId: "string",
containerDatabaseAdminPassword: "string",
pdbCreationTypeDetails: {
creationType: "string",
sourcePluggableDatabaseId: "string",
dblinkUserPassword: "string",
dblinkUsername: "string",
isThinClone: false,
refreshableCloneDetails: {
isRefreshableClone: false,
},
sourceContainerDatabaseAdminPassword: "string",
},
convertToRegularTrigger: 0,
refreshTrigger: 0,
rotateKeyTrigger: 0,
shouldCreatePdbBackup: false,
shouldPdbAdminAccountBeLocked: false,
tdeWalletPassword: "string",
});
type: oci:Database:PluggableDatabase
properties:
containerDatabaseAdminPassword: string
containerDatabaseId: string
convertToRegularTrigger: 0
definedTags:
string: string
freeformTags:
string: string
kmsKeyVersionId: string
pdbAdminPassword: string
pdbCreationTypeDetails:
creationType: string
dblinkUserPassword: string
dblinkUsername: string
isThinClone: false
refreshableCloneDetails:
isRefreshableClone: false
sourceContainerDatabaseAdminPassword: string
sourcePluggableDatabaseId: string
pdbName: string
refreshTrigger: 0
rotateKeyTrigger: 0
shouldCreatePdbBackup: false
shouldPdbAdminAccountBeLocked: false
tdeWalletPassword: string
PluggableDatabase 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 PluggableDatabase resource accepts the following input properties:
- Container
Database stringId - The OCID of the CDB
- Pdb
Name string - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- Container
Database stringAdmin Password - The DB system administrator password of the Container Database.
- Convert
To intRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- (Updatable) 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"} - Kms
Key stringVersion Id - Pdb
Admin stringPassword - A strong password for 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 -.
- Pdb
Creation PluggableType Details Database Pdb Creation Type Details The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- Refresh
Trigger int - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- Rotate
Key intTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Should
Create boolPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- Should
Pdb boolAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- Tde
Wallet stringPassword - The existing TDE wallet password of the CDB.
- Container
Database stringId - The OCID of the CDB
- Pdb
Name string - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- Container
Database stringAdmin Password - The DB system administrator password of the Container Database.
- Convert
To intRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- (Updatable) 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"} - Kms
Key stringVersion Id - Pdb
Admin stringPassword - A strong password for 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 -.
- Pdb
Creation PluggableType Details Database Pdb Creation Type Details Args The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- Refresh
Trigger int - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- Rotate
Key intTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Should
Create boolPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- Should
Pdb boolAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- Tde
Wallet stringPassword - The existing TDE wallet password of the CDB.
- container
Database StringId - The OCID of the CDB
- pdb
Name String - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- container
Database StringAdmin Password - The DB system administrator password of the Container Database.
- convert
To IntegerRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- (Updatable) 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"} - kms
Key StringVersion Id - pdb
Admin StringPassword - A strong password for 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 -.
- pdb
Creation PluggableType Details Pdb Creation Type Details The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- refresh
Trigger Integer - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- rotate
Key IntegerTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- should
Create BooleanPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- should
Pdb BooleanAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- tde
Wallet StringPassword - The existing TDE wallet password of the CDB.
- container
Database stringId - The OCID of the CDB
- pdb
Name string - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- container
Database stringAdmin Password - The DB system administrator password of the Container Database.
- convert
To numberRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- (Updatable) 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"} - kms
Key stringVersion Id - pdb
Admin stringPassword - A strong password for 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 -.
- pdb
Creation PluggableType Details Database Pdb Creation Type Details The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- refresh
Trigger number - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- rotate
Key numberTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- should
Create booleanPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- should
Pdb booleanAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- tde
Wallet stringPassword - The existing TDE wallet password of the CDB.
- container_
database_ strid - The OCID of the CDB
- pdb_
name str - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- container_
database_ stradmin_ password - The DB system administrator password of the Container Database.
- convert_
to_ intregular_ trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, str]
- (Updatable) 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"} - kms_
key_ strversion_ id - pdb_
admin_ strpassword - A strong password for 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 -.
- pdb_
creation_ database.type_ details Pluggable Database Pdb Creation Type Details Args The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- refresh_
trigger int - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- rotate_
key_ inttrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- should_
create_ boolpdb_ backup - Indicates whether to take Pluggable Database Backup after the operation.
- should_
pdb_ booladmin_ account_ be_ locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- tde_
wallet_ strpassword - The existing TDE wallet password of the CDB.
- container
Database StringId - The OCID of the CDB
- pdb
Name String - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- container
Database StringAdmin Password - The DB system administrator password of the Container Database.
- convert
To NumberRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- (Updatable) 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"} - kms
Key StringVersion Id - pdb
Admin StringPassword - A strong password for 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 -.
- pdb
Creation Property MapType Details The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- refresh
Trigger Number - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- rotate
Key NumberTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- should
Create BooleanPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- should
Pdb BooleanAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- tde
Wallet StringPassword - The existing TDE wallet password of the CDB.
Outputs
All input properties are implicitly available as output properties. Additionally, the PluggableDatabase resource produces the following output properties:
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings List<PluggableDatabase Connection String> - Connection strings to connect to an Oracle Pluggable Database.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Restricted bool - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- Lifecycle
Details string - Detailed message for the lifecycle state.
- Open
Mode string - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- Pdb
Node List<PluggableLevel Details Database Pdb Node Level Detail> - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- Pluggable
Database List<PluggableManagement Configs Database Pluggable Database Management Config> - The configuration of the Pluggable Database Management service.
- Refreshable
Clone List<PluggableConfigs Database Refreshable Clone Config> - Pluggable Database Refreshable Clone Configuration.
- State string
- The current state of the pluggable database.
- Time
Created string - The date and time the pluggable database was created.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings []PluggableDatabase Connection String - Connection strings to connect to an Oracle Pluggable Database.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Restricted bool - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- Lifecycle
Details string - Detailed message for the lifecycle state.
- Open
Mode string - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- Pdb
Node []PluggableLevel Details Database Pdb Node Level Detail - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- Pluggable
Database []PluggableManagement Configs Database Pluggable Database Management Config - The configuration of the Pluggable Database Management service.
- Refreshable
Clone []PluggableConfigs Database Refreshable Clone Config - Pluggable Database Refreshable Clone Configuration.
- State string
- The current state of the pluggable database.
- Time
Created string - The date and time the pluggable database was created.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<PluggableConnection String> - Connection strings to connect to an Oracle Pluggable Database.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Restricted Boolean - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- lifecycle
Details String - Detailed message for the lifecycle state.
- open
Mode String - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- pdb
Node List<PluggableLevel Details Pdb Node Level Detail> - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- pluggable
Database List<PluggableManagement Configs Pluggable Management Config> - The configuration of the Pluggable Database Management service.
- refreshable
Clone List<PluggableConfigs Refreshable Clone Config> - Pluggable Database Refreshable Clone Configuration.
- state String
- The current state of the pluggable database.
- time
Created String - The date and time the pluggable database was created.
- compartment
Id string - The OCID of the compartment.
- connection
Strings PluggableDatabase Connection String[] - Connection strings to connect to an Oracle Pluggable Database.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Restricted boolean - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- lifecycle
Details string - Detailed message for the lifecycle state.
- open
Mode string - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- pdb
Node PluggableLevel Details Database Pdb Node Level Detail[] - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- pluggable
Database PluggableManagement Configs Database Pluggable Database Management Config[] - The configuration of the Pluggable Database Management service.
- refreshable
Clone PluggableConfigs Database Refreshable Clone Config[] - Pluggable Database Refreshable Clone Configuration.
- state string
- The current state of the pluggable database.
- time
Created string - The date and time the pluggable database was created.
- compartment_
id str - The OCID of the compartment.
- connection_
strings Sequence[database.Pluggable Database Connection String] - Connection strings to connect to an Oracle Pluggable Database.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
restricted bool - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- lifecycle_
details str - Detailed message for the lifecycle state.
- open_
mode str - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- pdb_
node_ Sequence[database.level_ details Pluggable Database Pdb Node Level Detail] - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- pluggable_
database_ Sequence[database.management_ configs Pluggable Database Pluggable Database Management Config] - The configuration of the Pluggable Database Management service.
- refreshable_
clone_ Sequence[database.configs Pluggable Database Refreshable Clone Config] - Pluggable Database Refreshable Clone Configuration.
- state str
- The current state of the pluggable database.
- time_
created str - The date and time the pluggable database was created.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<Property Map> - Connection strings to connect to an Oracle Pluggable Database.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Restricted Boolean - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- lifecycle
Details String - Detailed message for the lifecycle state.
- open
Mode String - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- pdb
Node List<Property Map>Level Details - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- pluggable
Database List<Property Map>Management Configs - The configuration of the Pluggable Database Management service.
- refreshable
Clone List<Property Map>Configs - Pluggable Database Refreshable Clone Configuration.
- state String
- The current state of the pluggable database.
- time
Created String - The date and time the pluggable database was created.
Look up Existing PluggableDatabase Resource
Get an existing PluggableDatabase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PluggableDatabaseState, opts?: CustomResourceOptions): PluggableDatabase@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
connection_strings: Optional[Sequence[_database.PluggableDatabaseConnectionStringArgs]] = None,
container_database_admin_password: Optional[str] = None,
container_database_id: Optional[str] = None,
convert_to_regular_trigger: Optional[int] = None,
defined_tags: Optional[Mapping[str, str]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_restricted: Optional[bool] = None,
kms_key_version_id: Optional[str] = None,
lifecycle_details: Optional[str] = None,
open_mode: Optional[str] = None,
pdb_admin_password: Optional[str] = None,
pdb_creation_type_details: Optional[_database.PluggableDatabasePdbCreationTypeDetailsArgs] = None,
pdb_name: Optional[str] = None,
pdb_node_level_details: Optional[Sequence[_database.PluggableDatabasePdbNodeLevelDetailArgs]] = None,
pluggable_database_management_configs: Optional[Sequence[_database.PluggableDatabasePluggableDatabaseManagementConfigArgs]] = None,
refresh_trigger: Optional[int] = None,
refreshable_clone_configs: Optional[Sequence[_database.PluggableDatabaseRefreshableCloneConfigArgs]] = None,
rotate_key_trigger: Optional[int] = None,
should_create_pdb_backup: Optional[bool] = None,
should_pdb_admin_account_be_locked: Optional[bool] = None,
state: Optional[str] = None,
tde_wallet_password: Optional[str] = None,
time_created: Optional[str] = None) -> PluggableDatabasefunc GetPluggableDatabase(ctx *Context, name string, id IDInput, state *PluggableDatabaseState, opts ...ResourceOption) (*PluggableDatabase, error)public static PluggableDatabase Get(string name, Input<string> id, PluggableDatabaseState? state, CustomResourceOptions? opts = null)public static PluggableDatabase get(String name, Output<String> id, PluggableDatabaseState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings List<PluggableDatabase Connection String> - Connection strings to connect to an Oracle Pluggable Database.
- Container
Database stringAdmin Password - The DB system administrator password of the Container Database.
- Container
Database stringId - The OCID of the CDB
- Convert
To intRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, string>
- (Updatable) 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"} - Is
Restricted bool - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- Kms
Key stringVersion Id - Lifecycle
Details string - Detailed message for the lifecycle state.
- Open
Mode string - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- Pdb
Admin stringPassword - A strong password for 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 -.
- Pdb
Creation PluggableType Details Database Pdb Creation Type Details The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- Pdb
Name string - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- Pdb
Node List<PluggableLevel Details Database Pdb Node Level Detail> - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- Pluggable
Database List<PluggableManagement Configs Database Pluggable Database Management Config> - The configuration of the Pluggable Database Management service.
- Refresh
Trigger int - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- Refreshable
Clone List<PluggableConfigs Database Refreshable Clone Config> - Pluggable Database Refreshable Clone Configuration.
- Rotate
Key intTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Should
Create boolPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- Should
Pdb boolAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- State string
- The current state of the pluggable database.
- Tde
Wallet stringPassword - The existing TDE wallet password of the CDB.
- Time
Created string - The date and time the pluggable database was created.
- Compartment
Id string - The OCID of the compartment.
- Connection
Strings []PluggableDatabase Connection String Args - Connection strings to connect to an Oracle Pluggable Database.
- Container
Database stringAdmin Password - The DB system administrator password of the Container Database.
- Container
Database stringId - The OCID of the CDB
- Convert
To intRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]string
- (Updatable) 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"} - Is
Restricted bool - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- Kms
Key stringVersion Id - Lifecycle
Details string - Detailed message for the lifecycle state.
- Open
Mode string - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- Pdb
Admin stringPassword - A strong password for 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 -.
- Pdb
Creation PluggableType Details Database Pdb Creation Type Details Args The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- Pdb
Name string - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- Pdb
Node []PluggableLevel Details Database Pdb Node Level Detail Args - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- Pluggable
Database []PluggableManagement Configs Database Pluggable Database Management Config Args - The configuration of the Pluggable Database Management service.
- Refresh
Trigger int - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- Refreshable
Clone []PluggableConfigs Database Refreshable Clone Config Args - Pluggable Database Refreshable Clone Configuration.
- Rotate
Key intTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Should
Create boolPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- Should
Pdb boolAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- State string
- The current state of the pluggable database.
- Tde
Wallet stringPassword - The existing TDE wallet password of the CDB.
- Time
Created string - The date and time the pluggable database was created.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<PluggableConnection String> - Connection strings to connect to an Oracle Pluggable Database.
- container
Database StringAdmin Password - The DB system administrator password of the Container Database.
- container
Database StringId - The OCID of the CDB
- convert
To IntegerRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,String>
- (Updatable) 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"} - is
Restricted Boolean - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- kms
Key StringVersion Id - lifecycle
Details String - Detailed message for the lifecycle state.
- open
Mode String - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- pdb
Admin StringPassword - A strong password for 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 -.
- pdb
Creation PluggableType Details Pdb Creation Type Details The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- pdb
Name String - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- pdb
Node List<PluggableLevel Details Pdb Node Level Detail> - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- pluggable
Database List<PluggableManagement Configs Pluggable Management Config> - The configuration of the Pluggable Database Management service.
- refresh
Trigger Integer - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- refreshable
Clone List<PluggableConfigs Refreshable Clone Config> - Pluggable Database Refreshable Clone Configuration.
- rotate
Key IntegerTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- should
Create BooleanPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- should
Pdb BooleanAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- state String
- The current state of the pluggable database.
- tde
Wallet StringPassword - The existing TDE wallet password of the CDB.
- time
Created String - The date and time the pluggable database was created.
- compartment
Id string - The OCID of the compartment.
- connection
Strings PluggableDatabase Connection String[] - Connection strings to connect to an Oracle Pluggable Database.
- container
Database stringAdmin Password - The DB system administrator password of the Container Database.
- container
Database stringId - The OCID of the CDB
- convert
To numberRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: string}
- (Updatable) 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"} - is
Restricted boolean - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- kms
Key stringVersion Id - lifecycle
Details string - Detailed message for the lifecycle state.
- open
Mode string - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- pdb
Admin stringPassword - A strong password for 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 -.
- pdb
Creation PluggableType Details Database Pdb Creation Type Details The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- pdb
Name string - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- pdb
Node PluggableLevel Details Database Pdb Node Level Detail[] - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- pluggable
Database PluggableManagement Configs Database Pluggable Database Management Config[] - The configuration of the Pluggable Database Management service.
- refresh
Trigger number - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- refreshable
Clone PluggableConfigs Database Refreshable Clone Config[] - Pluggable Database Refreshable Clone Configuration.
- rotate
Key numberTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- should
Create booleanPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- should
Pdb booleanAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- state string
- The current state of the pluggable database.
- tde
Wallet stringPassword - The existing TDE wallet password of the CDB.
- time
Created string - The date and time the pluggable database was created.
- compartment_
id str - The OCID of the compartment.
- connection_
strings Sequence[database.Pluggable Database Connection String Args] - Connection strings to connect to an Oracle Pluggable Database.
- container_
database_ stradmin_ password - The DB system administrator password of the Container Database.
- container_
database_ strid - The OCID of the CDB
- convert_
to_ intregular_ trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, str]
- (Updatable) 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"} - is_
restricted bool - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- kms_
key_ strversion_ id - lifecycle_
details str - Detailed message for the lifecycle state.
- open_
mode str - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- pdb_
admin_ strpassword - A strong password for 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 -.
- pdb_
creation_ database.type_ details Pluggable Database Pdb Creation Type Details Args The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- pdb_
name str - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- pdb_
node_ Sequence[database.level_ details Pluggable Database Pdb Node Level Detail Args] - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- pluggable_
database_ Sequence[database.management_ configs Pluggable Database Pluggable Database Management Config Args] - The configuration of the Pluggable Database Management service.
- refresh_
trigger int - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- refreshable_
clone_ Sequence[database.configs Pluggable Database Refreshable Clone Config Args] - Pluggable Database Refreshable Clone Configuration.
- rotate_
key_ inttrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- should_
create_ boolpdb_ backup - Indicates whether to take Pluggable Database Backup after the operation.
- should_
pdb_ booladmin_ account_ be_ locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- state str
- The current state of the pluggable database.
- tde_
wallet_ strpassword - The existing TDE wallet password of the CDB.
- time_
created str - The date and time the pluggable database was created.
- compartment
Id String - The OCID of the compartment.
- connection
Strings List<Property Map> - Connection strings to connect to an Oracle Pluggable Database.
- container
Database StringAdmin Password - The DB system administrator password of the Container Database.
- container
Database StringId - The OCID of the CDB
- convert
To NumberRegular Trigger - (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String>
- (Updatable) 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"} - is
Restricted Boolean - The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.
- kms
Key StringVersion Id - lifecycle
Details String - Detailed message for the lifecycle state.
- open
Mode String - The mode that pluggable database is in. Open mode can only be changed to READ_ONLY or MIGRATE directly from the backend (within the Oracle Database software).
- pdb
Admin StringPassword - A strong password for 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 -.
- pdb
Creation Property MapType Details The Pluggable Database creation type. Use
LOCAL_CLONE_PDBfor creating a new PDB using Local Clone on Source Pluggable Database. This will Clone and starts a pluggable database (PDB) in the same database (CDB) as the source PDB. The source PDB must be in theREAD_WRITEopenMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. UseREMOTE_CLONE_PDBfor creating a new PDB using Remote Clone on Source Pluggable Database. This will Clone a pluggable database (PDB) to a different database from the source PDB. The cloned PDB will be started upon completion of the clone operation. The source PDB must be in theREAD_WRITEopenMode when performing the clone. For Exadata Cloud@Customer instances, the source pluggable database (PDB) must be on the same Exadata Infrastructure as the target container database (CDB) to create a remote clone. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure.Use
RELOCATE_PDBfor relocating the Pluggable Database from Source CDB and creating it in target CDB. This will relocate a pluggable database (PDB) to a different database from the source PDB. The source PDB must be in theREAD_WRITEopenMode when performing the relocate.- pdb
Name String - The name for the pluggable database (PDB). The name is unique in the context of a container database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. The pluggable database name should not be same as the container database name.
- pdb
Node List<Property Map>Level Details - Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
- pluggable
Database List<Property Map>Management Configs - The configuration of the Pluggable Database Management service.
- refresh
Trigger Number - (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
- refreshable
Clone List<Property Map>Configs - Pluggable Database Refreshable Clone Configuration.
- rotate
Key NumberTrigger (Updatable) An optional property when incremented triggers Rotate Key. Could be set to any integer value.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- should
Create BooleanPdb Backup - Indicates whether to take Pluggable Database Backup after the operation.
- should
Pdb BooleanAdmin Account Be Locked - The locked mode of the pluggable database admin account. If false, the user needs to provide the PDB Admin Password to connect to it. If true, the pluggable database will be locked and user cannot login to it.
- state String
- The current state of the pluggable database.
- tde
Wallet StringPassword - The existing TDE wallet password of the CDB.
- time
Created String - The date and time the pluggable database was created.
Supporting Types
PluggableDatabaseConnectionString, PluggableDatabaseConnectionStringArgs
- All
Connection Dictionary<string, string>Strings - All connection strings to use to connect to the pluggable database.
- Pdb
Default string - A host name-based PDB connection string.
- Pdb
Ip stringDefault - An IP-based PDB connection string.
- All
Connection map[string]stringStrings - All connection strings to use to connect to the pluggable database.
- Pdb
Default string - A host name-based PDB connection string.
- Pdb
Ip stringDefault - An IP-based PDB connection string.
- all
Connection Map<String,String>Strings - All connection strings to use to connect to the pluggable database.
- pdb
Default String - A host name-based PDB connection string.
- pdb
Ip StringDefault - An IP-based PDB connection string.
- all
Connection {[key: string]: string}Strings - All connection strings to use to connect to the pluggable database.
- pdb
Default string - A host name-based PDB connection string.
- pdb
Ip stringDefault - An IP-based PDB connection string.
- all_
connection_ Mapping[str, str]strings - All connection strings to use to connect to the pluggable database.
- pdb_
default str - A host name-based PDB connection string.
- pdb_
ip_ strdefault - An IP-based PDB connection string.
- all
Connection Map<String>Strings - All connection strings to use to connect to the pluggable database.
- pdb
Default String - A host name-based PDB connection string.
- pdb
Ip StringDefault - An IP-based PDB connection string.
PluggableDatabasePdbCreationTypeDetails, PluggableDatabasePdbCreationTypeDetailsArgs
- Creation
Type string - The Pluggable Database creation type.
- Source
Pluggable stringDatabase Id - The OCID of the Source Pluggable Database.
- Dblink
User stringPassword - The DB link user password.
- Dblink
Username string - The name of the DB link user.
- Is
Thin boolClone - True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
- Refreshable
Clone PluggableDetails Database Pdb Creation Type Details Refreshable Clone Details - Parameters for creating Pluggable Database Refreshable Clone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Source
Container stringDatabase Admin Password - The DB system administrator password of the source Container Database.
- Creation
Type string - The Pluggable Database creation type.
- Source
Pluggable stringDatabase Id - The OCID of the Source Pluggable Database.
- Dblink
User stringPassword - The DB link user password.
- Dblink
Username string - The name of the DB link user.
- Is
Thin boolClone - True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
- Refreshable
Clone PluggableDetails Database Pdb Creation Type Details Refreshable Clone Details - Parameters for creating Pluggable Database Refreshable Clone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- Source
Container stringDatabase Admin Password - The DB system administrator password of the source Container Database.
- creation
Type String - The Pluggable Database creation type.
- source
Pluggable StringDatabase Id - The OCID of the Source Pluggable Database.
- dblink
User StringPassword - The DB link user password.
- dblink
Username String - The name of the DB link user.
- is
Thin BooleanClone - True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
- refreshable
Clone PluggableDetails Pdb Creation Type Details Refreshable Clone Details - Parameters for creating Pluggable Database Refreshable Clone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- source
Container StringDatabase Admin Password - The DB system administrator password of the source Container Database.
- creation
Type string - The Pluggable Database creation type.
- source
Pluggable stringDatabase Id - The OCID of the Source Pluggable Database.
- dblink
User stringPassword - The DB link user password.
- dblink
Username string - The name of the DB link user.
- is
Thin booleanClone - True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
- refreshable
Clone PluggableDetails Database Pdb Creation Type Details Refreshable Clone Details - Parameters for creating Pluggable Database Refreshable Clone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- source
Container stringDatabase Admin Password - The DB system administrator password of the source Container Database.
- creation_
type str - The Pluggable Database creation type.
- source_
pluggable_ strdatabase_ id - The OCID of the Source Pluggable Database.
- dblink_
user_ strpassword - The DB link user password.
- dblink_
username str - The name of the DB link user.
- is_
thin_ boolclone - True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
- refreshable_
clone_ database.details Pluggable Database Pdb Creation Type Details Refreshable Clone Details - Parameters for creating Pluggable Database Refreshable Clone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- source_
container_ strdatabase_ admin_ password - The DB system administrator password of the source Container Database.
- creation
Type String - The Pluggable Database creation type.
- source
Pluggable StringDatabase Id - The OCID of the Source Pluggable Database.
- dblink
User StringPassword - The DB link user password.
- dblink
Username String - The name of the DB link user.
- is
Thin BooleanClone - True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
- refreshable
Clone Property MapDetails - Parameters for creating Pluggable Database Refreshable Clone. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
- source
Container StringDatabase Admin Password - The DB system administrator password of the source Container Database.
PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetails, PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetailsArgs
- Is
Refreshable boolClone - Indicates whether Pluggable Database is a refreshable clone.
- Is
Refreshable boolClone - Indicates whether Pluggable Database is a refreshable clone.
- is
Refreshable BooleanClone - Indicates whether Pluggable Database is a refreshable clone.
- is
Refreshable booleanClone - Indicates whether Pluggable Database is a refreshable clone.
- is_
refreshable_ boolclone - Indicates whether Pluggable Database is a refreshable clone.
- is
Refreshable BooleanClone - Indicates whether Pluggable Database is a refreshable clone.
PluggableDatabasePdbNodeLevelDetail, PluggableDatabasePdbNodeLevelDetailArgs
PluggableDatabasePluggableDatabaseManagementConfig, PluggableDatabasePluggableDatabaseManagementConfigArgs
- Management
Status string - The status of the Pluggable Database Management service.
- Management
Status string - The status of the Pluggable Database Management service.
- management
Status String - The status of the Pluggable Database Management service.
- management
Status string - The status of the Pluggable Database Management service.
- management_
status str - The status of the Pluggable Database Management service.
- management
Status String - The status of the Pluggable Database Management service.
PluggableDatabaseRefreshableCloneConfig, PluggableDatabaseRefreshableCloneConfigArgs
- Is
Refreshable boolClone - Indicates whether the Pluggable Database is a refreshable clone.
- Is
Refreshable boolClone - Indicates whether the Pluggable Database is a refreshable clone.
- is
Refreshable BooleanClone - Indicates whether the Pluggable Database is a refreshable clone.
- is
Refreshable booleanClone - Indicates whether the Pluggable Database is a refreshable clone.
- is_
refreshable_ boolclone - Indicates whether the Pluggable Database is a refreshable clone.
- is
Refreshable BooleanClone - Indicates whether the Pluggable Database is a refreshable clone.
Import
PluggableDatabases can be imported using the id, e.g.
$ pulumi import oci:Database/pluggableDatabase:PluggableDatabase test_pluggable_database "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.