autonomous_database_software_images
Creates, updates, deletes, gets or lists an autonomous_database_software_images resource.
Overview​
| Name | autonomous_database_software_images |
| Type | Resource |
| Id | oci.database.autonomous_database_software_images |
Fields​
The following fields are returned by SELECT queries:
- get
- list
The Autonomous AI Database Software Image.
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database Software Image. |
autonomousDsiOneOffPatches | array | One-off patches included in the Autonomous AI Database Software Image |
compartmentId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
databaseVersion | string | The database version with which the Autonomous AI Database Software Image is to be built. |
definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
displayName | string | The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique. |
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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
imageShapeFamily | string | To what shape the image is meant for. (EXACC_SHAPE, EXADATA_SHAPE) |
lifecycleDetails | string | Detailed message for the lifecycle state. |
lifecycleState | string | The current state of the Autonomous AI Database Software Image. (AVAILABLE, FAILED, PROVISIONING, EXPIRED, TERMINATED, TERMINATING, UPDATING) |
releaseUpdate | string | The Release Updates. |
systemTags | object | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
timeCreated | string (date-time) | The date and time the Autonomous AI Database Software Image was created. |
Retrieved the list of all the Autonomous AI Database Software Images.
| Name | Datatype | Description |
|---|---|---|
id | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database Software Image. |
autonomousDsiOneOffPatches | array | One-off patches included in the Autonomous AI Database Software Image |
compartmentId | string | The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. |
databaseVersion | string | The database version with which the Autonomous AI Database Software Image is to be built. |
definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
displayName | string | The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique. |
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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
imageShapeFamily | string | To what shape the image is meant for. (x-obmcs-enumref: #/definitions/AutonomousDatabaseSoftwareImage/imageShapeFamily) |
lifecycleDetails | string | Detailed message for the lifecycle state. |
lifecycleState | string | The current state of the Autonomous AI Database Software Image. (x-obmcs-enumref: #/definitions/AutonomousDatabaseSoftwareImage/lifecycleState) |
releaseUpdate | string | The Release Updates. |
systemTags | object | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). |
timeCreated | string (date-time) | The date and time the Autonomous AI Database Software Image was created. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | autonomousDatabaseSoftwareImageId, region | opc-request-id | Gets information about the specified Autonomous AI Database Software Image. |
list | select | compartmentId, imageShapeFamily, region | limit, page, sortOrder, sortBy, lifecycleState, opc-request-id, displayName | Gets a list of the Autonomous AI Database Software Images in the specified compartment.<br /> |
create | insert | region, compartmentId, displayName, sourceCdbId, imageShapeFamily | opc-retry-token, opc-request-id | create Autonomous AI Database Software Image in the specified compartment.<br /> |
update | update | autonomousDatabaseSoftwareImageId, region | if-match, opc-request-id | Updates the properties of an Autonomous AI Database Software Image, like add tags |
delete | delete | autonomousDatabaseSoftwareImageId, region | if-match, opc-request-id | Delete an Autonomous AI Database Software Image |
change_compartment | exec | autonomousDatabaseSoftwareImageId, region, compartmentId | opc-retry-token, opc-request-id, if-match | Move the Autonomous AI Database Software Image and its dependent resources to the specified compartment.<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 |
|---|---|---|
autonomousDatabaseSoftwareImageId | string | The Autonomous AI Database Software Image [OCID](/Content/General/Concepts/identifiers.htm). |
compartmentId | string | The compartment [OCID](/Content/General/Concepts/identifiers.htm). |
imageShapeFamily | string | A filter to return only resources that match the given image shape family exactly. |
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) |
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 to return only resources that match the given lifecycle state exactly. |
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 | parameter according to which Autonomous AI Database Software Images will be sorted. |
sortOrder | string | The sort order to use, either ascending (ASC) or descending (DESC). |
SELECT examples​
- get
- list
Gets information about the specified Autonomous AI Database Software Image.
SELECT
id,
autonomousDsiOneOffPatches,
compartmentId,
databaseVersion,
definedTags,
displayName,
freeformTags,
imageShapeFamily,
lifecycleDetails,
lifecycleState,
releaseUpdate,
systemTags,
timeCreated
FROM oci.database.autonomous_database_software_images
WHERE autonomousDatabaseSoftwareImageId = '{{ autonomousDatabaseSoftwareImageId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;
Gets a list of the Autonomous AI Database Software Images in the specified compartment.<br />
SELECT
id,
autonomousDsiOneOffPatches,
compartmentId,
databaseVersion,
definedTags,
displayName,
freeformTags,
imageShapeFamily,
lifecycleDetails,
lifecycleState,
releaseUpdate,
systemTags,
timeCreated
FROM oci.database.autonomous_database_software_images
WHERE compartmentId = '{{ compartmentId }}' -- required
AND imageShapeFamily = '{{ imageShapeFamily }}' -- 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 }}'
;
INSERT examples​
- create
- Manifest
create Autonomous AI Database Software Image in the specified compartment.<br />
INSERT INTO oci.database.autonomous_database_software_images (
compartmentId,
definedTags,
displayName,
freeformTags,
imageShapeFamily,
sourceCdbId,
region,
opc-retry-token,
opc-request-id
)
SELECT
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ imageShapeFamily }}' /* required */,
'{{ sourceCdbId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
autonomousDsiOneOffPatches,
compartmentId,
databaseVersion,
definedTags,
displayName,
freeformTags,
imageShapeFamily,
lifecycleDetails,
lifecycleState,
releaseUpdate,
systemTags,
timeCreated
;
# Description fields are for documentation purposes
- name: autonomous_database_software_images
props:
- name: region
value: "{{ region }}"
description: Required parameter for the autonomous_database_software_images resource.
- name: compartmentId
value: "{{ compartmentId }}"
description: |
The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
- name: definedTags
value: "{{ definedTags }}"
description: |
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
- name: displayName
value: "{{ displayName }}"
description: |
The user-friendly name for the Autonomous AI Database Software Image. The name does not have to be unique.
- name: freeformTags
value: "{{ freeformTags }}"
description: |
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](/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
- name: imageShapeFamily
value: "{{ imageShapeFamily }}"
description: |
To what shape the image is meant for.
valid_values: ['EXADATA_SHAPE', 'EXACC_SHAPE']
- name: sourceCdbId
value: "{{ sourceCdbId }}"
description: |
The source Autonomous Container Database [OCID](/Content/General/Concepts/identifiers.htm) from which to create Autonomous AI Database Software Image.
- name: opc-retry-token
value: "{{ opc-retry-token }}"
description: 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).
description: 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).
- name: opc-request-id
value: "{{ opc-request-id }}"
description: Unique identifier for the request.
description: Unique identifier for the request.
UPDATE examples​
- update
Updates the properties of an Autonomous AI Database Software Image, like add tags
UPDATE oci.database.autonomous_database_software_images
SET
definedTags = '{{ definedTags }}',
freeformTags = '{{ freeformTags }}'
WHERE
autonomousDatabaseSoftwareImageId = '{{ autonomousDatabaseSoftwareImageId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
autonomousDsiOneOffPatches,
compartmentId,
databaseVersion,
definedTags,
displayName,
freeformTags,
imageShapeFamily,
lifecycleDetails,
lifecycleState,
releaseUpdate,
systemTags,
timeCreated;
DELETE examples​
- delete
Delete an Autonomous AI Database Software Image
DELETE FROM oci.database.autonomous_database_software_images
WHERE autonomousDatabaseSoftwareImageId = '{{ autonomousDatabaseSoftwareImageId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;
Lifecycle Methods​
- change_compartment
Move the Autonomous AI Database Software Image and its dependent resources to the specified compartment.<br />
EXEC oci.database.autonomous_database_software_images.change_compartment
@autonomousDatabaseSoftwareImageId='{{ autonomousDatabaseSoftwareImageId }}' --required,
@region='{{ region }}' --required,
@opc-retry-token='{{ opc-retry-token }}',
@opc-request-id='{{ opc-request-id }}',
@if-match='{{ if-match }}'
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;