Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.Database.getDatabaseSoftwareImages
Explore with Pulumi AI
This data source provides the list of Database Software Images in Oracle Cloud Infrastructure Database service.
Gets a list of the database software images in the specified compartment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDatabaseSoftwareImages = oci.Database.getDatabaseSoftwareImages({
    compartmentId: compartmentId,
    dbSystemId: testDbSystem.id,
    displayName: databaseSoftwareImageDisplayName,
    imageShapeFamily: databaseSoftwareImageImageShapeFamily,
    imageType: databaseSoftwareImageImageType,
    isUpgradeSupported: databaseSoftwareImageIsUpgradeSupported,
    state: databaseSoftwareImageState,
});
import pulumi
import pulumi_oci as oci
test_database_software_images = oci.Database.get_database_software_images(compartment_id=compartment_id,
    db_system_id=test_db_system["id"],
    display_name=database_software_image_display_name,
    image_shape_family=database_software_image_image_shape_family,
    image_type=database_software_image_image_type,
    is_upgrade_supported=database_software_image_is_upgrade_supported,
    state=database_software_image_state)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/database"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := database.GetDatabaseSoftwareImages(ctx, &database.GetDatabaseSoftwareImagesArgs{
			CompartmentId:      compartmentId,
			DbSystemId:         pulumi.StringRef(testDbSystem.Id),
			DisplayName:        pulumi.StringRef(databaseSoftwareImageDisplayName),
			ImageShapeFamily:   pulumi.StringRef(databaseSoftwareImageImageShapeFamily),
			ImageType:          pulumi.StringRef(databaseSoftwareImageImageType),
			IsUpgradeSupported: pulumi.BoolRef(databaseSoftwareImageIsUpgradeSupported),
			State:              pulumi.StringRef(databaseSoftwareImageState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testDatabaseSoftwareImages = Oci.Database.GetDatabaseSoftwareImages.Invoke(new()
    {
        CompartmentId = compartmentId,
        DbSystemId = testDbSystem.Id,
        DisplayName = databaseSoftwareImageDisplayName,
        ImageShapeFamily = databaseSoftwareImageImageShapeFamily,
        ImageType = databaseSoftwareImageImageType,
        IsUpgradeSupported = databaseSoftwareImageIsUpgradeSupported,
        State = databaseSoftwareImageState,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Database.DatabaseFunctions;
import com.pulumi.oci.Database.inputs.GetDatabaseSoftwareImagesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var testDatabaseSoftwareImages = DatabaseFunctions.getDatabaseSoftwareImages(GetDatabaseSoftwareImagesArgs.builder()
            .compartmentId(compartmentId)
            .dbSystemId(testDbSystem.id())
            .displayName(databaseSoftwareImageDisplayName)
            .imageShapeFamily(databaseSoftwareImageImageShapeFamily)
            .imageType(databaseSoftwareImageImageType)
            .isUpgradeSupported(databaseSoftwareImageIsUpgradeSupported)
            .state(databaseSoftwareImageState)
            .build());
    }
}
variables:
  testDatabaseSoftwareImages:
    fn::invoke:
      function: oci:Database:getDatabaseSoftwareImages
      arguments:
        compartmentId: ${compartmentId}
        dbSystemId: ${testDbSystem.id}
        displayName: ${databaseSoftwareImageDisplayName}
        imageShapeFamily: ${databaseSoftwareImageImageShapeFamily}
        imageType: ${databaseSoftwareImageImageType}
        isUpgradeSupported: ${databaseSoftwareImageIsUpgradeSupported}
        state: ${databaseSoftwareImageState}
Using getDatabaseSoftwareImages
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDatabaseSoftwareImages(args: GetDatabaseSoftwareImagesArgs, opts?: InvokeOptions): Promise<GetDatabaseSoftwareImagesResult>
function getDatabaseSoftwareImagesOutput(args: GetDatabaseSoftwareImagesOutputArgs, opts?: InvokeOptions): Output<GetDatabaseSoftwareImagesResult>def get_database_software_images(compartment_id: Optional[str] = None,
                                 db_system_id: Optional[str] = None,
                                 display_name: Optional[str] = None,
                                 filters: Optional[Sequence[GetDatabaseSoftwareImagesFilter]] = None,
                                 image_shape_family: Optional[str] = None,
                                 image_type: Optional[str] = None,
                                 is_upgrade_supported: Optional[bool] = None,
                                 state: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetDatabaseSoftwareImagesResult
def get_database_software_images_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                 db_system_id: Optional[pulumi.Input[str]] = None,
                                 display_name: Optional[pulumi.Input[str]] = None,
                                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDatabaseSoftwareImagesFilterArgs]]]] = None,
                                 image_shape_family: Optional[pulumi.Input[str]] = None,
                                 image_type: Optional[pulumi.Input[str]] = None,
                                 is_upgrade_supported: Optional[pulumi.Input[bool]] = None,
                                 state: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseSoftwareImagesResult]func GetDatabaseSoftwareImages(ctx *Context, args *GetDatabaseSoftwareImagesArgs, opts ...InvokeOption) (*GetDatabaseSoftwareImagesResult, error)
func GetDatabaseSoftwareImagesOutput(ctx *Context, args *GetDatabaseSoftwareImagesOutputArgs, opts ...InvokeOption) GetDatabaseSoftwareImagesResultOutput> Note: This function is named GetDatabaseSoftwareImages in the Go SDK.
public static class GetDatabaseSoftwareImages 
{
    public static Task<GetDatabaseSoftwareImagesResult> InvokeAsync(GetDatabaseSoftwareImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseSoftwareImagesResult> Invoke(GetDatabaseSoftwareImagesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDatabaseSoftwareImagesResult> getDatabaseSoftwareImages(GetDatabaseSoftwareImagesArgs args, InvokeOptions options)
public static Output<GetDatabaseSoftwareImagesResult> getDatabaseSoftwareImages(GetDatabaseSoftwareImagesArgs args, InvokeOptions options)
fn::invoke:
  function: oci:Database/getDatabaseSoftwareImages:getDatabaseSoftwareImages
  arguments:
    # arguments dictionaryThe following arguments are supported:
- CompartmentId string
- The compartment OCID.
- DbSystem stringId 
- The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
- DisplayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
List<GetDatabase Software Images Filter> 
- ImageShape stringFamily 
- A filter to return only resources that match the given image shape family exactly.
- ImageType string
- A filter to return only resources that match the given image type exactly.
- IsUpgrade boolSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- State string
- A filter to return only resources that match the given lifecycle state exactly.
- CompartmentId string
- The compartment OCID.
- DbSystem stringId 
- The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
- DisplayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Filters
[]GetDatabase Software Images Filter 
- ImageShape stringFamily 
- A filter to return only resources that match the given image shape family exactly.
- ImageType string
- A filter to return only resources that match the given image type exactly.
- IsUpgrade boolSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- State string
- A filter to return only resources that match the given lifecycle state exactly.
- compartmentId String
- The compartment OCID.
- dbSystem StringId 
- The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
- displayName String
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
List<GetSoftware Images Filter> 
- imageShape StringFamily 
- A filter to return only resources that match the given image shape family exactly.
- imageType String
- A filter to return only resources that match the given image type exactly.
- isUpgrade BooleanSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- state String
- A filter to return only resources that match the given lifecycle state exactly.
- compartmentId string
- The compartment OCID.
- dbSystem stringId 
- The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
- displayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
GetDatabase Software Images Filter[] 
- imageShape stringFamily 
- A filter to return only resources that match the given image shape family exactly.
- imageType string
- A filter to return only resources that match the given image type exactly.
- isUpgrade booleanSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- state string
- A filter to return only resources that match the given lifecycle state exactly.
- compartment_id str
- The compartment OCID.
- db_system_ strid 
- The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
- display_name str
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters
Sequence[GetDatabase Software Images Filter] 
- image_shape_ strfamily 
- A filter to return only resources that match the given image shape family exactly.
- image_type str
- A filter to return only resources that match the given image type exactly.
- is_upgrade_ boolsupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- state str
- A filter to return only resources that match the given lifecycle state exactly.
- compartmentId String
- The compartment OCID.
- dbSystem StringId 
- The DB system OCID. If provided, filters the results to the set of database versions which are supported for the DB system.
- displayName String
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- filters List<Property Map>
- imageShape StringFamily 
- A filter to return only resources that match the given image shape family exactly.
- imageType String
- A filter to return only resources that match the given image type exactly.
- isUpgrade BooleanSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- state String
- A filter to return only resources that match the given lifecycle state exactly.
getDatabaseSoftwareImages Result
The following output properties are available:
- CompartmentId string
- The OCID of the compartment.
- DatabaseSoftware List<GetImages Database Software Images Database Software Image> 
- The list of database_software_images.
- Id string
- The provider-assigned unique ID for this managed resource.
- DbSystem stringId 
- DisplayName string
- The user-friendly name for the database software image. The name does not have to be unique.
- Filters
List<GetDatabase Software Images Filter> 
- ImageShape stringFamily 
- To what shape the image is meant for.
- ImageType string
- The type of software image. Can be grid or database.
- IsUpgrade boolSupported 
- True if this Database software image is supported for Upgrade.
- State string
- The current state of the database software image.
- CompartmentId string
- The OCID of the compartment.
- DatabaseSoftware []GetImages Database Software Images Database Software Image 
- The list of database_software_images.
- Id string
- The provider-assigned unique ID for this managed resource.
- DbSystem stringId 
- DisplayName string
- The user-friendly name for the database software image. The name does not have to be unique.
- Filters
[]GetDatabase Software Images Filter 
- ImageShape stringFamily 
- To what shape the image is meant for.
- ImageType string
- The type of software image. Can be grid or database.
- IsUpgrade boolSupported 
- True if this Database software image is supported for Upgrade.
- State string
- The current state of the database software image.
- compartmentId String
- The OCID of the compartment.
- databaseSoftware List<GetImages Software Images Software Image> 
- The list of database_software_images.
- id String
- The provider-assigned unique ID for this managed resource.
- dbSystem StringId 
- displayName String
- The user-friendly name for the database software image. The name does not have to be unique.
- filters
List<GetSoftware Images Filter> 
- imageShape StringFamily 
- To what shape the image is meant for.
- imageType String
- The type of software image. Can be grid or database.
- isUpgrade BooleanSupported 
- True if this Database software image is supported for Upgrade.
- state String
- The current state of the database software image.
- compartmentId string
- The OCID of the compartment.
- databaseSoftware GetImages Database Software Images Database Software Image[] 
- The list of database_software_images.
- id string
- The provider-assigned unique ID for this managed resource.
- dbSystem stringId 
- displayName string
- The user-friendly name for the database software image. The name does not have to be unique.
- filters
GetDatabase Software Images Filter[] 
- imageShape stringFamily 
- To what shape the image is meant for.
- imageType string
- The type of software image. Can be grid or database.
- isUpgrade booleanSupported 
- True if this Database software image is supported for Upgrade.
- state string
- The current state of the database software image.
- compartment_id str
- The OCID of the compartment.
- database_software_ Sequence[Getimages Database Software Images Database Software Image] 
- The list of database_software_images.
- id str
- The provider-assigned unique ID for this managed resource.
- db_system_ strid 
- display_name str
- The user-friendly name for the database software image. The name does not have to be unique.
- filters
Sequence[GetDatabase Software Images Filter] 
- image_shape_ strfamily 
- To what shape the image is meant for.
- image_type str
- The type of software image. Can be grid or database.
- is_upgrade_ boolsupported 
- True if this Database software image is supported for Upgrade.
- state str
- The current state of the database software image.
- compartmentId String
- The OCID of the compartment.
- databaseSoftware List<Property Map>Images 
- The list of database_software_images.
- id String
- The provider-assigned unique ID for this managed resource.
- dbSystem StringId 
- displayName String
- The user-friendly name for the database software image. The name does not have to be unique.
- filters List<Property Map>
- imageShape StringFamily 
- To what shape the image is meant for.
- imageType String
- The type of software image. Can be grid or database.
- isUpgrade BooleanSupported 
- True if this Database software image is supported for Upgrade.
- state String
- The current state of the database software image.
Supporting Types
GetDatabaseSoftwareImagesDatabaseSoftwareImage      
- CompartmentId string
- The compartment OCID.
- DatabaseSoftware List<string>Image Included Patches 
- List of one-off patches for Database Homes.
- DatabaseSoftware List<string>Image One Off Patches 
- List of one-off patches for Database Homes.
- DatabaseVersion string
- The database version with which the database software image is to be built.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- DisplayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Dictionary<string, string>
- 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"}
- Id string
- The OCID of the database software image.
- ImageShape stringFamily 
- A filter to return only resources that match the given image shape family exactly.
- ImageType string
- A filter to return only resources that match the given image type exactly.
- IncludedPatches stringSummary 
- The patches included in the image and the version of the image.
- IsUpgrade boolSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- LifecycleDetails string
- Detailed message for the lifecycle state.
- LsInventory string
- The output from the OPatch lsInventory command, which is passed as a string.
- PatchSet string
- The PSU or PBP or Release Updates. To get a list of supported versions, use the ListDbVersions operation.
- SourceDb stringHome Id 
- State string
- A filter to return only resources that match the given lifecycle state exactly.
- TimeCreated string
- The date and time the database software image was created.
- CompartmentId string
- The compartment OCID.
- DatabaseSoftware []stringImage Included Patches 
- List of one-off patches for Database Homes.
- DatabaseSoftware []stringImage One Off Patches 
- List of one-off patches for Database Homes.
- DatabaseVersion string
- The database version with which the database software image is to be built.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- DisplayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- map[string]string
- 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"}
- Id string
- The OCID of the database software image.
- ImageShape stringFamily 
- A filter to return only resources that match the given image shape family exactly.
- ImageType string
- A filter to return only resources that match the given image type exactly.
- IncludedPatches stringSummary 
- The patches included in the image and the version of the image.
- IsUpgrade boolSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- LifecycleDetails string
- Detailed message for the lifecycle state.
- LsInventory string
- The output from the OPatch lsInventory command, which is passed as a string.
- PatchSet string
- The PSU or PBP or Release Updates. To get a list of supported versions, use the ListDbVersions operation.
- SourceDb stringHome Id 
- State string
- A filter to return only resources that match the given lifecycle state exactly.
- TimeCreated string
- The date and time the database software image was created.
- compartmentId String
- The compartment OCID.
- databaseSoftware List<String>Image Included Patches 
- List of one-off patches for Database Homes.
- databaseSoftware List<String>Image One Off Patches 
- List of one-off patches for Database Homes.
- databaseVersion String
- The database version with which the database software image is to be built.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- displayName String
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Map<String,String>
- 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"}
- id String
- The OCID of the database software image.
- imageShape StringFamily 
- A filter to return only resources that match the given image shape family exactly.
- imageType String
- A filter to return only resources that match the given image type exactly.
- includedPatches StringSummary 
- The patches included in the image and the version of the image.
- isUpgrade BooleanSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- lifecycleDetails String
- Detailed message for the lifecycle state.
- lsInventory String
- The output from the OPatch lsInventory command, which is passed as a string.
- patchSet String
- The PSU or PBP or Release Updates. To get a list of supported versions, use the ListDbVersions operation.
- sourceDb StringHome Id 
- state String
- A filter to return only resources that match the given lifecycle state exactly.
- timeCreated String
- The date and time the database software image was created.
- compartmentId string
- The compartment OCID.
- databaseSoftware string[]Image Included Patches 
- List of one-off patches for Database Homes.
- databaseSoftware string[]Image One Off Patches 
- List of one-off patches for Database Homes.
- databaseVersion string
- The database version with which the database software image is to be built.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- displayName string
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- {[key: string]: string}
- 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"}
- id string
- The OCID of the database software image.
- imageShape stringFamily 
- A filter to return only resources that match the given image shape family exactly.
- imageType string
- A filter to return only resources that match the given image type exactly.
- includedPatches stringSummary 
- The patches included in the image and the version of the image.
- isUpgrade booleanSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- lifecycleDetails string
- Detailed message for the lifecycle state.
- lsInventory string
- The output from the OPatch lsInventory command, which is passed as a string.
- patchSet string
- The PSU or PBP or Release Updates. To get a list of supported versions, use the ListDbVersions operation.
- sourceDb stringHome Id 
- state string
- A filter to return only resources that match the given lifecycle state exactly.
- timeCreated string
- The date and time the database software image was created.
- compartment_id str
- The compartment OCID.
- database_software_ Sequence[str]image_ included_ patches 
- List of one-off patches for Database Homes.
- database_software_ Sequence[str]image_ one_ off_ patches 
- List of one-off patches for Database Homes.
- database_version str
- The database version with which the database software image is to be built.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display_name str
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Mapping[str, str]
- 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"}
- id str
- The OCID of the database software image.
- image_shape_ strfamily 
- A filter to return only resources that match the given image shape family exactly.
- image_type str
- A filter to return only resources that match the given image type exactly.
- included_patches_ strsummary 
- The patches included in the image and the version of the image.
- is_upgrade_ boolsupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- lifecycle_details str
- Detailed message for the lifecycle state.
- ls_inventory str
- The output from the OPatch lsInventory command, which is passed as a string.
- patch_set str
- The PSU or PBP or Release Updates. To get a list of supported versions, use the ListDbVersions operation.
- source_db_ strhome_ id 
- state str
- A filter to return only resources that match the given lifecycle state exactly.
- time_created str
- The date and time the database software image was created.
- compartmentId String
- The compartment OCID.
- databaseSoftware List<String>Image Included Patches 
- List of one-off patches for Database Homes.
- databaseSoftware List<String>Image One Off Patches 
- List of one-off patches for Database Homes.
- databaseVersion String
- The database version with which the database software image is to be built.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- displayName String
- A filter to return only resources that match the entire display name given. The match is not case sensitive.
- Map<String>
- 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"}
- id String
- The OCID of the database software image.
- imageShape StringFamily 
- A filter to return only resources that match the given image shape family exactly.
- imageType String
- A filter to return only resources that match the given image type exactly.
- includedPatches StringSummary 
- The patches included in the image and the version of the image.
- isUpgrade BooleanSupported 
- If provided, filters the results to the set of database versions which are supported for Upgrade.
- lifecycleDetails String
- Detailed message for the lifecycle state.
- lsInventory String
- The output from the OPatch lsInventory command, which is passed as a string.
- patchSet String
- The PSU or PBP or Release Updates. To get a list of supported versions, use the ListDbVersions operation.
- sourceDb StringHome Id 
- state String
- A filter to return only resources that match the given lifecycle state exactly.
- timeCreated String
- The date and time the database software image was created.
GetDatabaseSoftwareImagesFilter    
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.