db_connection_bundles

Creates, updates, deletes, gets or lists a db_connection_bundles resource.

Overview

Name	db_connection_bundles
Type	Resource
Id	oci.database.db_connection_bundles

Fields

The following fields are returned by SELECT queries:

get

The specified database connection bundle object.

Name	Datatype	Description
id	string	The OCID of the database connection bundle.
associatedResourceDetails	array	Details about the resources associated with the connection bundle.
compartmentId	string	The OCID of the compartment containing the database connection bundle.
dbConnectionBundleType	string	The type of the database connection bundle. (TLS, MTLS)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https:​//docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
displayName	string	Display name for the connection bundle.
freeformTags	object	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](https:​//docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
isProtected	boolean	True for the default, service-created Database Connection Bundle.
lifecycleState	string	The current lifecycle state of the database connection bundle. (CREATING, ACTIVE, INACTIVE, UPDATING, DELETING, DELETED, FAILED)
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https:​//docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
timeCreated	string (date-time)	The time the database connection bundle was created. An RFC3339 formatted datetime string.
timeLastRefreshed	string (date-time)	The time the database connection bundle was last refreshed. An RFC3339 formatted datetime string.
timeUpdated	string (date-time)	The time the database connection bundle was updated. An RFC3339 formatted datetime string.

list

Summary of a database connection bundle.

Name	Datatype	Description
id	string	The OCID of the database connection bundle.
associatedResourceDetails	array	Details about the resources associated with the connection bundle.
compartmentId	string	The OCID of the compartment containing the database connection bundle.
dbConnectionBundleType	string	The type of the database connection bundle. (TLS, MTLS)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https:​//docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
displayName	string	Display name for the connection bundle.
freeformTags	object	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](https:​//docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
isProtected	boolean	True for the default, service-created Database Connection Bundle.
lifecycleState	string	The current lifecycle state of the database connection bundle. (CREATING, ACTIVE, INACTIVE, UPDATING, DELETING, DELETED, FAILED)
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https:​//docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
timeCreated	string (date-time)	The time the database connection bundle was created. An RFC3339 formatted datetime string.
timeLastRefreshed	string (date-time)	The time the database connection bundle was last refreshed. An RFC3339 formatted datetime string.
timeUpdated	string (date-time)	The time the database connection bundle was updated. An RFC3339 formatted datetime string.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dbConnectionBundleId, region	opc-request-id	Gets information about the specified database connection bundle.
list	select	compartmentId, region	limit, page, sortOrder, sortBy, lifecycleState, opc-request-id, displayName, dbConnectionBundleType, associatedResourceId	Lists all database connection bundles that match the query parameters.<br />
download_db_connection_bundle	exec	dbConnectionBundleId, region, password	opc-request-id, if-match, opc-retry-token	Downloads the specified database connection bundle content.<br />The bundle is returned as a binary file containing the connection details.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
compartmentId	string	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
dbConnectionBundleId	string	The OCID of the database connection bundle.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
associatedResourceId	string	The OCID of the VM cluster associated with the connection bundle. If the parameter is set to null, all bundles are returned.
dbConnectionBundleType	string	A filter that returns only resources that match the specified database connection bundle type.
displayName	string	A filter to return only resources that match the entire display name given. The match is not case sensitive.
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleState	string	A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive.
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	The pagination token to continue listing from.
sortBy	string	The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for TIMEREFRESHED is descending.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples

get

Gets information about the specified database connection bundle.

SELECT
id,
associatedResourceDetails,
compartmentId,
dbConnectionBundleType,
definedTags,
displayName,
freeformTags,
isProtected,
lifecycleState,
systemTags,
timeCreated,
timeLastRefreshed,
timeUpdated
FROM oci.database.db_connection_bundles
WHERE dbConnectionBundleId = '{{ dbConnectionBundleId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists all database connection bundles that match the query parameters.<br />

SELECT
id,
associatedResourceDetails,
compartmentId,
dbConnectionBundleType,
definedTags,
displayName,
freeformTags,
isProtected,
lifecycleState,
systemTags,
timeCreated,
timeLastRefreshed,
timeUpdated
FROM oci.database.db_connection_bundles
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortOrder = '{{ sortOrder }}'
AND sortBy = '{{ sortBy }}'
AND lifecycleState = '{{ lifecycleState }}'
AND opc-request-id = '{{ opc-request-id }}'
AND displayName = '{{ displayName }}'
AND dbConnectionBundleType = '{{ dbConnectionBundleType }}'
AND associatedResourceId = '{{ associatedResourceId }}'
;

Lifecycle Methods

download_db_connection_bundle

Downloads the specified database connection bundle content.<br />The bundle is returned as a binary file containing the connection details.<br />

EXEC oci.database.db_connection_bundles.download_db_connection_bundle 
@dbConnectionBundleId='{{ dbConnectionBundleId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"password": "{{ password }}"
}'
;