Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

CloudDatabaseManagement

This resource provides the Database Management resource in Oracle Cloud Infrastructure Database service.

Enable / Update / Disable database management for the specified Oracle Database instance.

Database Management requires USER_NAME, PASSWORD_SECRET_ID and PRIVATE_END_POINT_ID. database.0.database_management_config is updated to appropriate managementType and managementStatus for the specified Oracle Database instance.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const test = new oci.database.CloudDatabaseManagement("test", {
    databaseId: oci_database_database.test_database.id,
    managementType: _var.database_cloud_database_management_details_management_type,
    privateEndPointId: _var.database_cloud_database_management_details_private_end_point_id,
    serviceName: _var.database_cloud_database_management_details_service_name,
    credentialdetails: {
        userName: _var.database_cloud_database_management_details_user_name,
        passwordSecretId: _var.database_cloud_database_management_details_password_secret_id,
    },
    enableManagement: _var.database_cloud_database_management_details_enable_management,
});

Coming soon!

Create a CloudDatabaseManagement Resource

new CloudDatabaseManagement(name: string, args: CloudDatabaseManagementArgs, opts?: CustomResourceOptions);
@overload
def CloudDatabaseManagement(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            credentialdetails: Optional[_database.CloudDatabaseManagementCredentialdetailsArgs] = None,
                            database_id: Optional[str] = None,
                            management_type: Optional[str] = None,
                            private_end_point_id: Optional[str] = None,
                            service_name: Optional[str] = None)
@overload
def CloudDatabaseManagement(resource_name: str,
                            args: CloudDatabaseManagementArgs,
                            opts: Optional[ResourceOptions] = None)
func NewCloudDatabaseManagement(ctx *Context, name string, args CloudDatabaseManagementArgs, opts ...ResourceOption) (*CloudDatabaseManagement, error)
public CloudDatabaseManagement(string name, CloudDatabaseManagementArgs args, CustomResourceOptions? opts = null)
public CloudDatabaseManagement(String name, CloudDatabaseManagementArgs args)
public CloudDatabaseManagement(String name, CloudDatabaseManagementArgs args, CustomResourceOptions options)
type: oci:Database:CloudDatabaseManagement
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CloudDatabaseManagementArgs
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 CloudDatabaseManagementArgs
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 CloudDatabaseManagementArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CloudDatabaseManagementArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CloudDatabaseManagementArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CloudDatabaseManagement 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 CloudDatabaseManagement resource accepts the following input properties:

Credentialdetails CloudDatabaseManagementCredentialdetailsArgs
DatabaseId string

The database OCID.

ManagementType string

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
PrivateEndPointId string

(Updatable) The private end point OCID.

ServiceName string

(Updatable) Database service name

Credentialdetails CloudDatabaseManagementCredentialdetailsArgs
DatabaseId string

The database OCID.

ManagementType string

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
PrivateEndPointId string

(Updatable) The private end point OCID.

ServiceName string

(Updatable) Database service name

credentialdetails CloudManagementCredentialdetailsArgs
databaseId String

The database OCID.

managementType String

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
privateEndPointId String

(Updatable) The private end point OCID.

serviceName String

(Updatable) Database service name

credentialdetails CloudDatabaseManagementCredentialdetailsArgs
databaseId string

The database OCID.

managementType string

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
privateEndPointId string

(Updatable) The private end point OCID.

serviceName string

(Updatable) Database service name

credentialdetails CloudDatabaseManagementCredentialdetailsArgs
database_id str

The database OCID.

management_type str

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
private_end_point_id str

(Updatable) The private end point OCID.

service_name str

(Updatable) Database service name

credentialdetails Property Map
databaseId String

The database OCID.

managementType String

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
privateEndPointId String

(Updatable) The private end point OCID.

serviceName String

(Updatable) Database service name

Outputs

All input properties are implicitly available as output properties. Additionally, the CloudDatabaseManagement resource produces the following output properties:

EnableManagement bool

(Updatable) Use this flag to enable/disable database management

Id string

The provider-assigned unique ID for this managed resource.

KmsKeyId string

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

KmsKeyVersionId string

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

LastBackupTimestamp string

The date and time when the latest database backup was created.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database.

PdbName string

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

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

SourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

State string

The current state of the database.

TimeCreated string

The date and time the database was created.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

VmClusterId string

The OCID of the VM cluster.

EnableManagement bool

(Updatable) Use this flag to enable/disable database management

Id string

The provider-assigned unique ID for this managed resource.

KmsKeyId string

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

KmsKeyVersionId string

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

LastBackupTimestamp string

The date and time when the latest database backup was created.

LifecycleDetails string

Additional information about the current lifecycle state.

NcharacterSet string

The national character set for the database.

PdbName string

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

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

SourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

State string

The current state of the database.

TimeCreated string

The date and time the database was created.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

VmClusterId string

The OCID of the VM cluster.

enableManagement Boolean

(Updatable) Use this flag to enable/disable database management

id String

The provider-assigned unique ID for this managed resource.

kmsKeyId String

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

kmsKeyVersionId String

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

lastBackupTimestamp String

The date and time when the latest database backup was created.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database.

pdbName String

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

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp String

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state String

The current state of the database.

timeCreated String

The date and time the database was created.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId String

The OCID of the VM cluster.

enableManagement boolean

(Updatable) Use this flag to enable/disable database management

id string

The provider-assigned unique ID for this managed resource.

kmsKeyId string

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

kmsKeyVersionId string

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

lastBackupTimestamp string

The date and time when the latest database backup was created.

lifecycleDetails string

Additional information about the current lifecycle state.

ncharacterSet string

The national character set for the database.

pdbName string

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

sidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state string

The current state of the database.

timeCreated string

The date and time the database was created.

vaultId string

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId string

The OCID of the VM cluster.

enable_management bool

(Updatable) Use this flag to enable/disable database management

id str

The provider-assigned unique ID for this managed resource.

kms_key_id str

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

kms_key_version_id str

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

last_backup_timestamp str

The date and time when the latest database backup was created.

lifecycle_details str

Additional information about the current lifecycle state.

ncharacter_set str

The national character set for the database.

pdb_name str

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

sid_prefix str

Specifies a prefix for the Oracle SID of the database to be created.

source_database_point_in_time_recovery_timestamp str

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state str

The current state of the database.

time_created str

The date and time the database was created.

vault_id str

The OCID of the Oracle Cloud Infrastructure vault.

vm_cluster_id str

The OCID of the VM cluster.

enableManagement Boolean

(Updatable) Use this flag to enable/disable database management

id String

The provider-assigned unique ID for this managed resource.

kmsKeyId String

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

kmsKeyVersionId String

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

lastBackupTimestamp String

The date and time when the latest database backup was created.

lifecycleDetails String

Additional information about the current lifecycle state.

ncharacterSet String

The national character set for the database.

pdbName String

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

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp String

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state String

The current state of the database.

timeCreated String

The date and time the database was created.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId String

The OCID of the VM cluster.

Look up an Existing CloudDatabaseManagement Resource

Get an existing CloudDatabaseManagement 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?: CloudDatabaseManagementState, opts?: CustomResourceOptions): CloudDatabaseManagement
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credentialdetails: Optional[_database.CloudDatabaseManagementCredentialdetailsArgs] = None,
        database_id: Optional[str] = None,
        enable_management: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        kms_key_version_id: Optional[str] = None,
        last_backup_timestamp: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        management_type: Optional[str] = None,
        ncharacter_set: Optional[str] = None,
        pdb_name: Optional[str] = None,
        private_end_point_id: Optional[str] = None,
        service_name: Optional[str] = None,
        sid_prefix: Optional[str] = None,
        source_database_point_in_time_recovery_timestamp: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        vault_id: Optional[str] = None,
        vm_cluster_id: Optional[str] = None) -> CloudDatabaseManagement
func GetCloudDatabaseManagement(ctx *Context, name string, id IDInput, state *CloudDatabaseManagementState, opts ...ResourceOption) (*CloudDatabaseManagement, error)
public static CloudDatabaseManagement Get(string name, Input<string> id, CloudDatabaseManagementState? state, CustomResourceOptions? opts = null)
public static CloudDatabaseManagement get(String name, Output<String> id, CloudDatabaseManagementState 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:
Credentialdetails CloudDatabaseManagementCredentialdetailsArgs
DatabaseId string

The database OCID.

EnableManagement bool

(Updatable) Use this flag to enable/disable database management

KmsKeyId string

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

KmsKeyVersionId string

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

LastBackupTimestamp string

The date and time when the latest database backup was created.

LifecycleDetails string

Additional information about the current lifecycle state.

ManagementType string

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
NcharacterSet string

The national character set for the database.

PdbName string

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

PrivateEndPointId string

(Updatable) The private end point OCID.

ServiceName string

(Updatable) Database service name

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

SourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

State string

The current state of the database.

TimeCreated string

The date and time the database was created.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

VmClusterId string

The OCID of the VM cluster.

Credentialdetails CloudDatabaseManagementCredentialdetailsArgs
DatabaseId string

The database OCID.

EnableManagement bool

(Updatable) Use this flag to enable/disable database management

KmsKeyId string

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

KmsKeyVersionId string

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

LastBackupTimestamp string

The date and time when the latest database backup was created.

LifecycleDetails string

Additional information about the current lifecycle state.

ManagementType string

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
NcharacterSet string

The national character set for the database.

PdbName string

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

PrivateEndPointId string

(Updatable) The private end point OCID.

ServiceName string

(Updatable) Database service name

SidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

SourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

State string

The current state of the database.

TimeCreated string

The date and time the database was created.

VaultId string

The OCID of the Oracle Cloud Infrastructure vault.

VmClusterId string

The OCID of the VM cluster.

credentialdetails CloudManagementCredentialdetailsArgs
databaseId String

The database OCID.

enableManagement Boolean

(Updatable) Use this flag to enable/disable database management

kmsKeyId String

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

kmsKeyVersionId String

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

lastBackupTimestamp String

The date and time when the latest database backup was created.

lifecycleDetails String

Additional information about the current lifecycle state.

managementType String

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
ncharacterSet String

The national character set for the database.

pdbName String

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

privateEndPointId String

(Updatable) The private end point OCID.

serviceName String

(Updatable) Database service name

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp String

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state String

The current state of the database.

timeCreated String

The date and time the database was created.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId String

The OCID of the VM cluster.

credentialdetails CloudDatabaseManagementCredentialdetailsArgs
databaseId string

The database OCID.

enableManagement boolean

(Updatable) Use this flag to enable/disable database management

kmsKeyId string

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

kmsKeyVersionId string

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

lastBackupTimestamp string

The date and time when the latest database backup was created.

lifecycleDetails string

Additional information about the current lifecycle state.

managementType string

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
ncharacterSet string

The national character set for the database.

pdbName string

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

privateEndPointId string

(Updatable) The private end point OCID.

serviceName string

(Updatable) Database service name

sidPrefix string

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp string

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state string

The current state of the database.

timeCreated string

The date and time the database was created.

vaultId string

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId string

The OCID of the VM cluster.

credentialdetails CloudDatabaseManagementCredentialdetailsArgs
database_id str

The database OCID.

enable_management bool

(Updatable) Use this flag to enable/disable database management

kms_key_id str

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

kms_key_version_id str

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

last_backup_timestamp str

The date and time when the latest database backup was created.

lifecycle_details str

Additional information about the current lifecycle state.

management_type str

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
ncharacter_set str

The national character set for the database.

pdb_name str

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

private_end_point_id str

(Updatable) The private end point OCID.

service_name str

(Updatable) Database service name

sid_prefix str

Specifies a prefix for the Oracle SID of the database to be created.

source_database_point_in_time_recovery_timestamp str

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state str

The current state of the database.

time_created str

The date and time the database was created.

vault_id str

The OCID of the Oracle Cloud Infrastructure vault.

vm_cluster_id str

The OCID of the VM cluster.

credentialdetails Property Map
databaseId String

The database OCID.

enableManagement Boolean

(Updatable) Use this flag to enable/disable database management

kmsKeyId String

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

kmsKeyVersionId String

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation.

lastBackupTimestamp String

The date and time when the latest database backup was created.

lifecycleDetails String

Additional information about the current lifecycle state.

managementType String

(Updatable) Specifies database management type enum:

  • BASIC
  • ADVANCED
ncharacterSet String

The national character set for the database.

pdbName String

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

privateEndPointId String

(Updatable) The private end point OCID.

serviceName String

(Updatable) Database service name

sidPrefix String

Specifies a prefix for the Oracle SID of the database to be created.

sourceDatabasePointInTimeRecoveryTimestamp String

Point in time recovery timeStamp of the source database at which cloned database system is cloned from the source database system, as described in RFC 3339

state String

The current state of the database.

timeCreated String

The date and time the database was created.

vaultId String

The OCID of the Oracle Cloud Infrastructure vault.

vmClusterId String

The OCID of the VM cluster.

Supporting Types

CloudDatabaseManagementCredentialdetails

PasswordSecretId string

Specific database username's password OCID.

UserName string

Database username

PasswordSecretId string

Specific database username's password OCID.

UserName string

Database username

passwordSecretId String

Specific database username's password OCID.

userName String

Database username

passwordSecretId string

Specific database username's password OCID.

userName string

Database username

password_secret_id str

Specific database username's password OCID.

user_name str

Database username

passwordSecretId String

Specific database username's password OCID.

userName String

Database username

Import

Import is not supported for this resource.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.