Oracle Cloud Infrastructure
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
Cloud
Database Management Credentialdetails Args - Database
Id string The database OCID.
- Management
Type string (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- Private
End stringPoint Id (Updatable) The private end point OCID.
- Service
Name string (Updatable) Database service name
- Credentialdetails
Cloud
Database Management Credentialdetails Args - Database
Id string The database OCID.
- Management
Type string (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- Private
End stringPoint Id (Updatable) The private end point OCID.
- Service
Name string (Updatable) Database service name
- credentialdetails
Cloud
Management Credentialdetails Args - database
Id String The database OCID.
- management
Type String (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- private
End StringPoint Id (Updatable) The private end point OCID.
- service
Name String (Updatable) Database service name
- credentialdetails
Cloud
Database Management Credentialdetails Args - database
Id string The database OCID.
- management
Type string (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- private
End stringPoint Id (Updatable) The private end point OCID.
- service
Name string (Updatable) Database service name
- credentialdetails
Cloud
Database Management Credentialdetails Args - database_
id str The database OCID.
- management_
type str (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- private_
end_ strpoint_ id (Updatable) The private end point OCID.
- service_
name str (Updatable) Database service name
- credentialdetails Property Map
- database
Id String The database OCID.
- management
Type String (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- private
End StringPoint Id (Updatable) The private end point OCID.
- service
Name String (Updatable) Database service name
Outputs
All input properties are implicitly available as output properties. Additionally, the CloudDatabaseManagement resource produces the following output properties:
- Enable
Management bool (Updatable) Use this flag to enable/disable database management
- Id string
The provider-assigned unique ID for this managed resource.
- Kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id 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 stringTimestamp The date and time when the latest database backup was created.
- Lifecycle
Details string Additional information about the current lifecycle state.
- Ncharacter
Set string The national character set for the database.
- Pdb
Name 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.
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Source
Database stringPoint In Time Recovery Timestamp 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.
- Time
Created string The date and time the database was created.
- Vault
Id string - Vm
Cluster stringId The OCID of the VM cluster.
- Enable
Management bool (Updatable) Use this flag to enable/disable database management
- Id string
The provider-assigned unique ID for this managed resource.
- Kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id 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 stringTimestamp The date and time when the latest database backup was created.
- Lifecycle
Details string Additional information about the current lifecycle state.
- Ncharacter
Set string The national character set for the database.
- Pdb
Name 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.
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Source
Database stringPoint In Time Recovery Timestamp 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.
- Time
Created string The date and time the database was created.
- Vault
Id string - Vm
Cluster stringId The OCID of the VM cluster.
- enable
Management Boolean (Updatable) Use this flag to enable/disable database management
- id String
The provider-assigned unique ID for this managed resource.
- kms
Key StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id 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 StringTimestamp The date and time when the latest database backup was created.
- lifecycle
Details String Additional information about the current lifecycle state.
- ncharacter
Set String The national character set for the database.
- pdb
Name 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.
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database StringPoint In Time Recovery Timestamp 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.
- time
Created String The date and time the database was created.
- vault
Id String - vm
Cluster StringId The OCID of the VM cluster.
- enable
Management boolean (Updatable) Use this flag to enable/disable database management
- id string
The provider-assigned unique ID for this managed resource.
- kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key stringVersion Id 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 stringTimestamp The date and time when the latest database backup was created.
- lifecycle
Details string Additional information about the current lifecycle state.
- ncharacter
Set string The national character set for the database.
- pdb
Name 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.
- sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database stringPoint In Time Recovery Timestamp 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.
- time
Created string The date and time the database was created.
- vault
Id string - vm
Cluster stringId 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_ strid The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_
key_ strversion_ id 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_ strtimestamp 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_ strpoint_ in_ time_ recovery_ timestamp 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 - vm_
cluster_ strid The OCID of the VM cluster.
- enable
Management Boolean (Updatable) Use this flag to enable/disable database management
- id String
The provider-assigned unique ID for this managed resource.
- kms
Key StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id 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 StringTimestamp The date and time when the latest database backup was created.
- lifecycle
Details String Additional information about the current lifecycle state.
- ncharacter
Set String The national character set for the database.
- pdb
Name 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.
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database StringPoint In Time Recovery Timestamp 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.
- time
Created String The date and time the database was created.
- vault
Id String - vm
Cluster StringId 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.
- Credentialdetails
Cloud
Database Management Credentialdetails Args - Database
Id string The database OCID.
- Enable
Management bool (Updatable) Use this flag to enable/disable database management
- Kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id 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 stringTimestamp The date and time when the latest database backup was created.
- Lifecycle
Details string Additional information about the current lifecycle state.
- Management
Type string (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- Ncharacter
Set string The national character set for the database.
- Pdb
Name 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.
- Private
End stringPoint Id (Updatable) The private end point OCID.
- Service
Name string (Updatable) Database service name
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Source
Database stringPoint In Time Recovery Timestamp 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.
- Time
Created string The date and time the database was created.
- Vault
Id string - Vm
Cluster stringId The OCID of the VM cluster.
- Credentialdetails
Cloud
Database Management Credentialdetails Args - Database
Id string The database OCID.
- Enable
Management bool (Updatable) Use this flag to enable/disable database management
- Kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- Kms
Key stringVersion Id 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 stringTimestamp The date and time when the latest database backup was created.
- Lifecycle
Details string Additional information about the current lifecycle state.
- Management
Type string (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- Ncharacter
Set string The national character set for the database.
- Pdb
Name 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.
- Private
End stringPoint Id (Updatable) The private end point OCID.
- Service
Name string (Updatable) Database service name
- Sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- Source
Database stringPoint In Time Recovery Timestamp 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.
- Time
Created string The date and time the database was created.
- Vault
Id string - Vm
Cluster stringId The OCID of the VM cluster.
- credentialdetails
Cloud
Management Credentialdetails Args - database
Id String The database OCID.
- enable
Management Boolean (Updatable) Use this flag to enable/disable database management
- kms
Key StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id 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 StringTimestamp The date and time when the latest database backup was created.
- lifecycle
Details String Additional information about the current lifecycle state.
- management
Type String (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- ncharacter
Set String The national character set for the database.
- pdb
Name 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.
- private
End StringPoint Id (Updatable) The private end point OCID.
- service
Name String (Updatable) Database service name
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database StringPoint In Time Recovery Timestamp 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.
- time
Created String The date and time the database was created.
- vault
Id String - vm
Cluster StringId The OCID of the VM cluster.
- credentialdetails
Cloud
Database Management Credentialdetails Args - database
Id string The database OCID.
- enable
Management boolean (Updatable) Use this flag to enable/disable database management
- kms
Key stringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key stringVersion Id 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 stringTimestamp The date and time when the latest database backup was created.
- lifecycle
Details string Additional information about the current lifecycle state.
- management
Type string (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- ncharacter
Set string The national character set for the database.
- pdb
Name 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.
- private
End stringPoint Id (Updatable) The private end point OCID.
- service
Name string (Updatable) Database service name
- sid
Prefix string Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database stringPoint In Time Recovery Timestamp 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.
- time
Created string The date and time the database was created.
- vault
Id string - vm
Cluster stringId The OCID of the VM cluster.
- credentialdetails
Cloud
Database Management Credentialdetails Args - database_
id str The database OCID.
- enable_
management bool (Updatable) Use this flag to enable/disable database management
- kms_
key_ strid The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms_
key_ strversion_ id 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_ strtimestamp 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_ strpoint_ id (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_ strpoint_ in_ time_ recovery_ timestamp 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 - vm_
cluster_ strid The OCID of the VM cluster.
- credentialdetails Property Map
- database
Id String The database OCID.
- enable
Management Boolean (Updatable) Use this flag to enable/disable database management
- kms
Key StringId The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
- kms
Key StringVersion Id 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 StringTimestamp The date and time when the latest database backup was created.
- lifecycle
Details String Additional information about the current lifecycle state.
- management
Type String (Updatable) Specifies database management type enum:
BASIC
ADVANCED
- ncharacter
Set String The national character set for the database.
- pdb
Name 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.
- private
End StringPoint Id (Updatable) The private end point OCID.
- service
Name String (Updatable) Database service name
- sid
Prefix String Specifies a prefix for the
Oracle SID
of the database to be created.- source
Database StringPoint In Time Recovery Timestamp 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.
- time
Created String The date and time the database was created.
- vault
Id String - vm
Cluster StringId The OCID of the VM cluster.
Supporting Types
CloudDatabaseManagementCredentialdetails
- Password
Secret stringId Specific database username's password OCID.
- User
Name string Database username
- Password
Secret stringId Specific database username's password OCID.
- User
Name string Database username
- password
Secret StringId Specific database username's password OCID.
- user
Name String Database username
- password
Secret stringId Specific database username's password OCID.
- user
Name string Database username
- password_
secret_ strid Specific database username's password OCID.
- user_
name str Database username
- password
Secret StringId Specific database username's password OCID.
- user
Name 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.