Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Database
  5. PluggableDatabase
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Database.PluggableDatabase

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

    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_creation_type_details: Optional[_database.PluggableDatabasePdbCreationTypeDetailsArgs] = None,
                      defined_tags: Optional[Mapping[str, str]] = None,
                      freeform_tags: Optional[Mapping[str, str]] = None,
                      pdb_admin_password: Optional[str] = None,
                      container_database_admin_password: Optional[str] = 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",
    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",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    PdbAdminPassword = "string",
    ContainerDatabaseAdminPassword = "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"),
	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"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PdbAdminPassword:               pulumi.String("string"),
	ContainerDatabaseAdminPassword: 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")
    .pdbCreationTypeDetails(PluggableDatabasePdbCreationTypeDetailsArgs.builder()
        .creationType("string")
        .sourcePluggableDatabaseId("string")
        .dblinkUserPassword("string")
        .dblinkUsername("string")
        .isThinClone(false)
        .refreshableCloneDetails(PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetailsArgs.builder()
            .isRefreshableClone(false)
            .build())
        .sourceContainerDatabaseAdminPassword("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .pdbAdminPassword("string")
    .containerDatabaseAdminPassword("string")
    .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_creation_type_details=oci.database.PluggableDatabasePdbCreationTypeDetailsArgs(
        creation_type="string",
        source_pluggable_database_id="string",
        dblink_user_password="string",
        dblink_username="string",
        is_thin_clone=False,
        refreshable_clone_details=oci.database.PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetailsArgs(
            is_refreshable_clone=False,
        ),
        source_container_database_admin_password="string",
    ),
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    pdb_admin_password="string",
    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",
    pdbCreationTypeDetails: {
        creationType: "string",
        sourcePluggableDatabaseId: "string",
        dblinkUserPassword: "string",
        dblinkUsername: "string",
        isThinClone: false,
        refreshableCloneDetails: {
            isRefreshableClone: false,
        },
        sourceContainerDatabaseAdminPassword: "string",
    },
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    pdbAdminPassword: "string",
    containerDatabaseAdminPassword: "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
    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

    The PluggableDatabase resource accepts the following input properties:

    ContainerDatabaseId string
    The OCID of the CDB
    PdbName 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.
    ContainerDatabaseAdminPassword string
    The DB system administrator password of the Container Database.
    ConvertToRegularTrigger int
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags 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"}
    PdbAdminPassword string
    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 -.
    PdbCreationTypeDetails PluggableDatabasePdbCreationTypeDetails

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    RefreshTrigger int
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    RotateKeyTrigger int

    (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

    ShouldCreatePdbBackup bool
    Indicates whether to take Pluggable Database Backup after the operation.
    ShouldPdbAdminAccountBeLocked bool
    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.
    TdeWalletPassword string
    The existing TDE wallet password of the CDB.
    ContainerDatabaseId string
    The OCID of the CDB
    PdbName 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.
    ContainerDatabaseAdminPassword string
    The DB system administrator password of the Container Database.
    ConvertToRegularTrigger int
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags 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"}
    PdbAdminPassword string
    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 -.
    PdbCreationTypeDetails PluggableDatabasePdbCreationTypeDetailsArgs

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    RefreshTrigger int
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    RotateKeyTrigger int

    (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

    ShouldCreatePdbBackup bool
    Indicates whether to take Pluggable Database Backup after the operation.
    ShouldPdbAdminAccountBeLocked bool
    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.
    TdeWalletPassword string
    The existing TDE wallet password of the CDB.
    containerDatabaseId String
    The OCID of the CDB
    pdbName 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.
    containerDatabaseAdminPassword String
    The DB system administrator password of the Container Database.
    convertToRegularTrigger Integer
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags 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"}
    pdbAdminPassword String
    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 -.
    pdbCreationTypeDetails PluggablePdbCreationTypeDetails

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    refreshTrigger Integer
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    rotateKeyTrigger Integer

    (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

    shouldCreatePdbBackup Boolean
    Indicates whether to take Pluggable Database Backup after the operation.
    shouldPdbAdminAccountBeLocked Boolean
    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.
    tdeWalletPassword String
    The existing TDE wallet password of the CDB.
    containerDatabaseId string
    The OCID of the CDB
    pdbName 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.
    containerDatabaseAdminPassword string
    The DB system administrator password of the Container Database.
    convertToRegularTrigger number
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags {[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"}
    pdbAdminPassword string
    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 -.
    pdbCreationTypeDetails PluggableDatabasePdbCreationTypeDetails

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    refreshTrigger number
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    rotateKeyTrigger number

    (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

    shouldCreatePdbBackup boolean
    Indicates whether to take Pluggable Database Backup after the operation.
    shouldPdbAdminAccountBeLocked boolean
    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.
    tdeWalletPassword string
    The existing TDE wallet password of the CDB.
    container_database_id str
    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_admin_password str
    The DB system administrator password of the Container Database.
    convert_to_regular_trigger int
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeform_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"}
    pdb_admin_password str
    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_type_details database.PluggableDatabasePdbCreationTypeDetailsArgs

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    refresh_trigger int
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    rotate_key_trigger int

    (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_pdb_backup bool
    Indicates whether to take Pluggable Database Backup after the operation.
    should_pdb_admin_account_be_locked bool
    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_password str
    The existing TDE wallet password of the CDB.
    containerDatabaseId String
    The OCID of the CDB
    pdbName 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.
    containerDatabaseAdminPassword String
    The DB system administrator password of the Container Database.
    convertToRegularTrigger Number
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags 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"}
    pdbAdminPassword String
    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 -.
    pdbCreationTypeDetails Property Map

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    refreshTrigger Number
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    rotateKeyTrigger Number

    (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

    shouldCreatePdbBackup Boolean
    Indicates whether to take Pluggable Database Backup after the operation.
    shouldPdbAdminAccountBeLocked Boolean
    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.
    tdeWalletPassword String
    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:

    CompartmentId string
    The OCID of the compartment.
    ConnectionStrings List<PluggableDatabaseConnectionString>
    Connection strings to connect to an Oracle Pluggable Database.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsRestricted 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.
    LifecycleDetails string
    Detailed message for the lifecycle state.
    OpenMode 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).
    PdbNodeLevelDetails List<PluggableDatabasePdbNodeLevelDetail>
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    PluggableDatabaseManagementConfigs List<PluggableDatabasePluggableDatabaseManagementConfig>
    The configuration of the Pluggable Database Management service.
    RefreshableCloneConfigs List<PluggableDatabaseRefreshableCloneConfig>
    Pluggable Database Refreshable Clone Configuration.
    State string
    The current state of the pluggable database.
    TimeCreated string
    The date and time the pluggable database was created.
    CompartmentId string
    The OCID of the compartment.
    ConnectionStrings []PluggableDatabaseConnectionString
    Connection strings to connect to an Oracle Pluggable Database.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsRestricted 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.
    LifecycleDetails string
    Detailed message for the lifecycle state.
    OpenMode 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).
    PdbNodeLevelDetails []PluggableDatabasePdbNodeLevelDetail
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    PluggableDatabaseManagementConfigs []PluggableDatabasePluggableDatabaseManagementConfig
    The configuration of the Pluggable Database Management service.
    RefreshableCloneConfigs []PluggableDatabaseRefreshableCloneConfig
    Pluggable Database Refreshable Clone Configuration.
    State string
    The current state of the pluggable database.
    TimeCreated string
    The date and time the pluggable database was created.
    compartmentId String
    The OCID of the compartment.
    connectionStrings List<PluggableConnectionString>
    Connection strings to connect to an Oracle Pluggable Database.
    id String
    The provider-assigned unique ID for this managed resource.
    isRestricted 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.
    lifecycleDetails String
    Detailed message for the lifecycle state.
    openMode 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).
    pdbNodeLevelDetails List<PluggablePdbNodeLevelDetail>
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    pluggableDatabaseManagementConfigs List<PluggablePluggableManagementConfig>
    The configuration of the Pluggable Database Management service.
    refreshableCloneConfigs List<PluggableRefreshableCloneConfig>
    Pluggable Database Refreshable Clone Configuration.
    state String
    The current state of the pluggable database.
    timeCreated String
    The date and time the pluggable database was created.
    compartmentId string
    The OCID of the compartment.
    connectionStrings PluggableDatabaseConnectionString[]
    Connection strings to connect to an Oracle Pluggable Database.
    id string
    The provider-assigned unique ID for this managed resource.
    isRestricted 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.
    lifecycleDetails string
    Detailed message for the lifecycle state.
    openMode 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).
    pdbNodeLevelDetails PluggableDatabasePdbNodeLevelDetail[]
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    pluggableDatabaseManagementConfigs PluggableDatabasePluggableDatabaseManagementConfig[]
    The configuration of the Pluggable Database Management service.
    refreshableCloneConfigs PluggableDatabaseRefreshableCloneConfig[]
    Pluggable Database Refreshable Clone Configuration.
    state string
    The current state of the pluggable database.
    timeCreated string
    The date and time the pluggable database was created.
    compartment_id str
    The OCID of the compartment.
    connection_strings Sequence[database.PluggableDatabaseConnectionString]
    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_level_details Sequence[database.PluggableDatabasePdbNodeLevelDetail]
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    pluggable_database_management_configs Sequence[database.PluggableDatabasePluggableDatabaseManagementConfig]
    The configuration of the Pluggable Database Management service.
    refreshable_clone_configs Sequence[database.PluggableDatabaseRefreshableCloneConfig]
    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.
    compartmentId String
    The OCID of the compartment.
    connectionStrings List<Property Map>
    Connection strings to connect to an Oracle Pluggable Database.
    id String
    The provider-assigned unique ID for this managed resource.
    isRestricted 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.
    lifecycleDetails String
    Detailed message for the lifecycle state.
    openMode 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).
    pdbNodeLevelDetails List<Property Map>
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    pluggableDatabaseManagementConfigs List<Property Map>
    The configuration of the Pluggable Database Management service.
    refreshableCloneConfigs List<Property Map>
    Pluggable Database Refreshable Clone Configuration.
    state String
    The current state of the pluggable database.
    timeCreated 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,
        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) -> PluggableDatabase
    func 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.
    The following state arguments are supported:
    CompartmentId string
    The OCID of the compartment.
    ConnectionStrings List<PluggableDatabaseConnectionString>
    Connection strings to connect to an Oracle Pluggable Database.
    ContainerDatabaseAdminPassword string
    The DB system administrator password of the Container Database.
    ContainerDatabaseId string
    The OCID of the CDB
    ConvertToRegularTrigger int
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags 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"}
    IsRestricted 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.
    LifecycleDetails string
    Detailed message for the lifecycle state.
    OpenMode 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).
    PdbAdminPassword string
    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 -.
    PdbCreationTypeDetails PluggableDatabasePdbCreationTypeDetails

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    PdbName 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.
    PdbNodeLevelDetails List<PluggableDatabasePdbNodeLevelDetail>
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    PluggableDatabaseManagementConfigs List<PluggableDatabasePluggableDatabaseManagementConfig>
    The configuration of the Pluggable Database Management service.
    RefreshTrigger int
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    RefreshableCloneConfigs List<PluggableDatabaseRefreshableCloneConfig>
    Pluggable Database Refreshable Clone Configuration.
    RotateKeyTrigger int

    (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

    ShouldCreatePdbBackup bool
    Indicates whether to take Pluggable Database Backup after the operation.
    ShouldPdbAdminAccountBeLocked bool
    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.
    TdeWalletPassword string
    The existing TDE wallet password of the CDB.
    TimeCreated string
    The date and time the pluggable database was created.
    CompartmentId string
    The OCID of the compartment.
    ConnectionStrings []PluggableDatabaseConnectionStringArgs
    Connection strings to connect to an Oracle Pluggable Database.
    ContainerDatabaseAdminPassword string
    The DB system administrator password of the Container Database.
    ContainerDatabaseId string
    The OCID of the CDB
    ConvertToRegularTrigger int
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    FreeformTags 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"}
    IsRestricted 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.
    LifecycleDetails string
    Detailed message for the lifecycle state.
    OpenMode 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).
    PdbAdminPassword string
    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 -.
    PdbCreationTypeDetails PluggableDatabasePdbCreationTypeDetailsArgs

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    PdbName 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.
    PdbNodeLevelDetails []PluggableDatabasePdbNodeLevelDetailArgs
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    PluggableDatabaseManagementConfigs []PluggableDatabasePluggableDatabaseManagementConfigArgs
    The configuration of the Pluggable Database Management service.
    RefreshTrigger int
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    RefreshableCloneConfigs []PluggableDatabaseRefreshableCloneConfigArgs
    Pluggable Database Refreshable Clone Configuration.
    RotateKeyTrigger int

    (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

    ShouldCreatePdbBackup bool
    Indicates whether to take Pluggable Database Backup after the operation.
    ShouldPdbAdminAccountBeLocked bool
    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.
    TdeWalletPassword string
    The existing TDE wallet password of the CDB.
    TimeCreated string
    The date and time the pluggable database was created.
    compartmentId String
    The OCID of the compartment.
    connectionStrings List<PluggableConnectionString>
    Connection strings to connect to an Oracle Pluggable Database.
    containerDatabaseAdminPassword String
    The DB system administrator password of the Container Database.
    containerDatabaseId String
    The OCID of the CDB
    convertToRegularTrigger Integer
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags 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"}
    isRestricted 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.
    lifecycleDetails String
    Detailed message for the lifecycle state.
    openMode 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).
    pdbAdminPassword String
    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 -.
    pdbCreationTypeDetails PluggablePdbCreationTypeDetails

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    pdbName 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.
    pdbNodeLevelDetails List<PluggablePdbNodeLevelDetail>
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    pluggableDatabaseManagementConfigs List<PluggablePluggableManagementConfig>
    The configuration of the Pluggable Database Management service.
    refreshTrigger Integer
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    refreshableCloneConfigs List<PluggableRefreshableCloneConfig>
    Pluggable Database Refreshable Clone Configuration.
    rotateKeyTrigger Integer

    (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

    shouldCreatePdbBackup Boolean
    Indicates whether to take Pluggable Database Backup after the operation.
    shouldPdbAdminAccountBeLocked Boolean
    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.
    tdeWalletPassword String
    The existing TDE wallet password of the CDB.
    timeCreated String
    The date and time the pluggable database was created.
    compartmentId string
    The OCID of the compartment.
    connectionStrings PluggableDatabaseConnectionString[]
    Connection strings to connect to an Oracle Pluggable Database.
    containerDatabaseAdminPassword string
    The DB system administrator password of the Container Database.
    containerDatabaseId string
    The OCID of the CDB
    convertToRegularTrigger number
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags {[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"}
    isRestricted 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.
    lifecycleDetails string
    Detailed message for the lifecycle state.
    openMode 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).
    pdbAdminPassword string
    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 -.
    pdbCreationTypeDetails PluggableDatabasePdbCreationTypeDetails

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    pdbName 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.
    pdbNodeLevelDetails PluggableDatabasePdbNodeLevelDetail[]
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    pluggableDatabaseManagementConfigs PluggableDatabasePluggableDatabaseManagementConfig[]
    The configuration of the Pluggable Database Management service.
    refreshTrigger number
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    refreshableCloneConfigs PluggableDatabaseRefreshableCloneConfig[]
    Pluggable Database Refreshable Clone Configuration.
    rotateKeyTrigger number

    (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

    shouldCreatePdbBackup boolean
    Indicates whether to take Pluggable Database Backup after the operation.
    shouldPdbAdminAccountBeLocked boolean
    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.
    tdeWalletPassword string
    The existing TDE wallet password of the CDB.
    timeCreated string
    The date and time the pluggable database was created.
    compartment_id str
    The OCID of the compartment.
    connection_strings Sequence[database.PluggableDatabaseConnectionStringArgs]
    Connection strings to connect to an Oracle Pluggable Database.
    container_database_admin_password str
    The DB system administrator password of the Container Database.
    container_database_id str
    The OCID of the CDB
    convert_to_regular_trigger int
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeform_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.
    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_password str
    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_type_details database.PluggableDatabasePdbCreationTypeDetailsArgs

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode 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_level_details Sequence[database.PluggableDatabasePdbNodeLevelDetailArgs]
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    pluggable_database_management_configs Sequence[database.PluggableDatabasePluggableDatabaseManagementConfigArgs]
    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_configs Sequence[database.PluggableDatabaseRefreshableCloneConfigArgs]
    Pluggable Database Refreshable Clone Configuration.
    rotate_key_trigger int

    (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_pdb_backup bool
    Indicates whether to take Pluggable Database Backup after the operation.
    should_pdb_admin_account_be_locked bool
    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_password str
    The existing TDE wallet password of the CDB.
    time_created str
    The date and time the pluggable database was created.
    compartmentId String
    The OCID of the compartment.
    connectionStrings List<Property Map>
    Connection strings to connect to an Oracle Pluggable Database.
    containerDatabaseAdminPassword String
    The DB system administrator password of the Container Database.
    containerDatabaseId String
    The OCID of the CDB
    convertToRegularTrigger Number
    (Updatable) An optional property when incremented triggers Convert To Regular. Could be set to any integer value.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    freeformTags 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"}
    isRestricted 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.
    lifecycleDetails String
    Detailed message for the lifecycle state.
    openMode 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).
    pdbAdminPassword String
    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 -.
    pdbCreationTypeDetails Property Map

    The Pluggable Database creation type. Use LOCAL_CLONE_PDB for 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 the READ_WRITE openMode to perform the clone operation. isThinClone options are supported only for Exadata VM cluster on Exascale Infrastructure. Use REMOTE_CLONE_PDB for 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 the READ_WRITE openMode 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_PDB for 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 the READ_WRITE openMode when performing the relocate.

    pdbName 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.
    pdbNodeLevelDetails List<Property Map>
    Pluggable Database Node Level Details. Example: [{"nodeName" : "node1", "openMode" : "READ_WRITE"}, {"nodeName" : "node2", "openMode" : "READ_ONLY"}]
    pluggableDatabaseManagementConfigs List<Property Map>
    The configuration of the Pluggable Database Management service.
    refreshTrigger Number
    (Updatable) An optional property when incremented triggers Refresh. Could be set to any integer value.
    refreshableCloneConfigs List<Property Map>
    Pluggable Database Refreshable Clone Configuration.
    rotateKeyTrigger Number

    (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

    shouldCreatePdbBackup Boolean
    Indicates whether to take Pluggable Database Backup after the operation.
    shouldPdbAdminAccountBeLocked Boolean
    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.
    tdeWalletPassword String
    The existing TDE wallet password of the CDB.
    timeCreated String
    The date and time the pluggable database was created.

    Supporting Types

    PluggableDatabaseConnectionString, PluggableDatabaseConnectionStringArgs

    AllConnectionStrings Dictionary<string, string>
    All connection strings to use to connect to the pluggable database.
    PdbDefault string
    A host name-based PDB connection string.
    PdbIpDefault string
    An IP-based PDB connection string.
    AllConnectionStrings map[string]string
    All connection strings to use to connect to the pluggable database.
    PdbDefault string
    A host name-based PDB connection string.
    PdbIpDefault string
    An IP-based PDB connection string.
    allConnectionStrings Map<String,String>
    All connection strings to use to connect to the pluggable database.
    pdbDefault String
    A host name-based PDB connection string.
    pdbIpDefault String
    An IP-based PDB connection string.
    allConnectionStrings {[key: string]: string}
    All connection strings to use to connect to the pluggable database.
    pdbDefault string
    A host name-based PDB connection string.
    pdbIpDefault string
    An IP-based PDB connection string.
    all_connection_strings Mapping[str, str]
    All connection strings to use to connect to the pluggable database.
    pdb_default str
    A host name-based PDB connection string.
    pdb_ip_default str
    An IP-based PDB connection string.
    allConnectionStrings Map<String>
    All connection strings to use to connect to the pluggable database.
    pdbDefault String
    A host name-based PDB connection string.
    pdbIpDefault String
    An IP-based PDB connection string.

    PluggableDatabasePdbCreationTypeDetails, PluggableDatabasePdbCreationTypeDetailsArgs

    CreationType string
    The Pluggable Database creation type.
    SourcePluggableDatabaseId string
    The OCID of the Source Pluggable Database.
    DblinkUserPassword string
    The DB link user password.
    DblinkUsername string
    The name of the DB link user.
    IsThinClone bool
    True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
    RefreshableCloneDetails PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetails
    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.
    SourceContainerDatabaseAdminPassword string
    The DB system administrator password of the source Container Database.
    CreationType string
    The Pluggable Database creation type.
    SourcePluggableDatabaseId string
    The OCID of the Source Pluggable Database.
    DblinkUserPassword string
    The DB link user password.
    DblinkUsername string
    The name of the DB link user.
    IsThinClone bool
    True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
    RefreshableCloneDetails PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetails
    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.
    SourceContainerDatabaseAdminPassword string
    The DB system administrator password of the source Container Database.
    creationType String
    The Pluggable Database creation type.
    sourcePluggableDatabaseId String
    The OCID of the Source Pluggable Database.
    dblinkUserPassword String
    The DB link user password.
    dblinkUsername String
    The name of the DB link user.
    isThinClone Boolean
    True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
    refreshableCloneDetails PluggablePdbCreationTypeDetailsRefreshableCloneDetails
    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.
    sourceContainerDatabaseAdminPassword String
    The DB system administrator password of the source Container Database.
    creationType string
    The Pluggable Database creation type.
    sourcePluggableDatabaseId string
    The OCID of the Source Pluggable Database.
    dblinkUserPassword string
    The DB link user password.
    dblinkUsername string
    The name of the DB link user.
    isThinClone boolean
    True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
    refreshableCloneDetails PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetails
    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.
    sourceContainerDatabaseAdminPassword string
    The DB system administrator password of the source Container Database.
    creation_type str
    The Pluggable Database creation type.
    source_pluggable_database_id str
    The OCID of the Source Pluggable Database.
    dblink_user_password str
    The DB link user password.
    dblink_username str
    The name of the DB link user.
    is_thin_clone bool
    True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
    refreshable_clone_details database.PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetails
    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_database_admin_password str
    The DB system administrator password of the source Container Database.
    creationType String
    The Pluggable Database creation type.
    sourcePluggableDatabaseId String
    The OCID of the Source Pluggable Database.
    dblinkUserPassword String
    The DB link user password.
    dblinkUsername String
    The name of the DB link user.
    isThinClone Boolean
    True if Pluggable Database needs to be thin cloned and false if Pluggable Database needs to be thick cloned.
    refreshableCloneDetails Property Map
    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.
    sourceContainerDatabaseAdminPassword String
    The DB system administrator password of the source Container Database.

    PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetails, PluggableDatabasePdbCreationTypeDetailsRefreshableCloneDetailsArgs

    IsRefreshableClone bool
    Indicates whether Pluggable Database is a refreshable clone.
    IsRefreshableClone bool
    Indicates whether Pluggable Database is a refreshable clone.
    isRefreshableClone Boolean
    Indicates whether Pluggable Database is a refreshable clone.
    isRefreshableClone boolean
    Indicates whether Pluggable Database is a refreshable clone.
    is_refreshable_clone bool
    Indicates whether Pluggable Database is a refreshable clone.
    isRefreshableClone Boolean
    Indicates whether Pluggable Database is a refreshable clone.

    PluggableDatabasePdbNodeLevelDetail, PluggableDatabasePdbNodeLevelDetailArgs

    NodeName string
    The Node name of the Database Instance.
    OpenMode 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).
    NodeName string
    The Node name of the Database Instance.
    OpenMode 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).
    nodeName String
    The Node name of the Database Instance.
    openMode 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).
    nodeName string
    The Node name of the Database Instance.
    openMode 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).
    node_name str
    The Node name of the Database Instance.
    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).
    nodeName String
    The Node name of the Database Instance.
    openMode 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).

    PluggableDatabasePluggableDatabaseManagementConfig, PluggableDatabasePluggableDatabaseManagementConfigArgs

    ManagementStatus string
    The status of the Pluggable Database Management service.
    ManagementStatus string
    The status of the Pluggable Database Management service.
    managementStatus String
    The status of the Pluggable Database Management service.
    managementStatus string
    The status of the Pluggable Database Management service.
    management_status str
    The status of the Pluggable Database Management service.
    managementStatus String
    The status of the Pluggable Database Management service.

    PluggableDatabaseRefreshableCloneConfig, PluggableDatabaseRefreshableCloneConfigArgs

    IsRefreshableClone bool
    Indicates whether the Pluggable Database is a refreshable clone.
    IsRefreshableClone bool
    Indicates whether the Pluggable Database is a refreshable clone.
    isRefreshableClone Boolean
    Indicates whether the Pluggable Database is a refreshable clone.
    isRefreshableClone boolean
    Indicates whether the Pluggable Database is a refreshable clone.
    is_refreshable_clone bool
    Indicates whether the Pluggable Database is a refreshable clone.
    isRefreshableClone Boolean
    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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
    pulumi/pulumi-oci