1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getDedicatedAiClusters
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

oci.GenerativeAi.getDedicatedAiClusters

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

    This data source provides the list of Dedicated Ai Clusters in Oracle Cloud Infrastructure Generative Ai service.

    Lists the dedicated AI clusters in a specific compartment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDedicatedAiClusters = oci.GenerativeAi.getDedicatedAiClusters({
        compartmentId: _var.compartment_id,
        displayName: _var.dedicated_ai_cluster_display_name,
        id: _var.dedicated_ai_cluster_id,
        state: _var.dedicated_ai_cluster_state,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_dedicated_ai_clusters = oci.GenerativeAi.get_dedicated_ai_clusters(compartment_id=var["compartment_id"],
        display_name=var["dedicated_ai_cluster_display_name"],
        id=var["dedicated_ai_cluster_id"],
        state=var["dedicated_ai_cluster_state"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/GenerativeAi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := GenerativeAi.GetDedicatedAiClusters(ctx, &generativeai.GetDedicatedAiClustersArgs{
    			CompartmentId: _var.Compartment_id,
    			DisplayName:   pulumi.StringRef(_var.Dedicated_ai_cluster_display_name),
    			Id:            pulumi.StringRef(_var.Dedicated_ai_cluster_id),
    			State:         pulumi.StringRef(_var.Dedicated_ai_cluster_state),
    		}, 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 testDedicatedAiClusters = Oci.GenerativeAi.GetDedicatedAiClusters.Invoke(new()
        {
            CompartmentId = @var.Compartment_id,
            DisplayName = @var.Dedicated_ai_cluster_display_name,
            Id = @var.Dedicated_ai_cluster_id,
            State = @var.Dedicated_ai_cluster_state,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
    import com.pulumi.oci.GenerativeAi.inputs.GetDedicatedAiClustersArgs;
    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 testDedicatedAiClusters = GenerativeAiFunctions.getDedicatedAiClusters(GetDedicatedAiClustersArgs.builder()
                .compartmentId(var_.compartment_id())
                .displayName(var_.dedicated_ai_cluster_display_name())
                .id(var_.dedicated_ai_cluster_id())
                .state(var_.dedicated_ai_cluster_state())
                .build());
    
        }
    }
    
    variables:
      testDedicatedAiClusters:
        fn::invoke:
          Function: oci:GenerativeAi:getDedicatedAiClusters
          Arguments:
            compartmentId: ${var.compartment_id}
            displayName: ${var.dedicated_ai_cluster_display_name}
            id: ${var.dedicated_ai_cluster_id}
            state: ${var.dedicated_ai_cluster_state}
    

    Using getDedicatedAiClusters

    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 getDedicatedAiClusters(args: GetDedicatedAiClustersArgs, opts?: InvokeOptions): Promise<GetDedicatedAiClustersResult>
    function getDedicatedAiClustersOutput(args: GetDedicatedAiClustersOutputArgs, opts?: InvokeOptions): Output<GetDedicatedAiClustersResult>
    def get_dedicated_ai_clusters(compartment_id: Optional[str] = None,
                                  display_name: Optional[str] = None,
                                  filters: Optional[Sequence[_generativeai.GetDedicatedAiClustersFilter]] = None,
                                  id: Optional[str] = None,
                                  state: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetDedicatedAiClustersResult
    def get_dedicated_ai_clusters_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                  display_name: Optional[pulumi.Input[str]] = None,
                                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[_generativeai.GetDedicatedAiClustersFilterArgs]]]] = None,
                                  id: Optional[pulumi.Input[str]] = None,
                                  state: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetDedicatedAiClustersResult]
    func GetDedicatedAiClusters(ctx *Context, args *GetDedicatedAiClustersArgs, opts ...InvokeOption) (*GetDedicatedAiClustersResult, error)
    func GetDedicatedAiClustersOutput(ctx *Context, args *GetDedicatedAiClustersOutputArgs, opts ...InvokeOption) GetDedicatedAiClustersResultOutput

    > Note: This function is named GetDedicatedAiClusters in the Go SDK.

    public static class GetDedicatedAiClusters 
    {
        public static Task<GetDedicatedAiClustersResult> InvokeAsync(GetDedicatedAiClustersArgs args, InvokeOptions? opts = null)
        public static Output<GetDedicatedAiClustersResult> Invoke(GetDedicatedAiClustersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDedicatedAiClustersResult> getDedicatedAiClusters(GetDedicatedAiClustersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:GenerativeAi/getDedicatedAiClusters:getDedicatedAiClusters
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetDedicatedAiClustersFilter>
    Id string
    The OCID of the dedicated AI cluster.
    State string
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetDedicatedAiClustersFilter
    Id string
    The OCID of the dedicated AI cluster.
    State string
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetDedicatedAiClustersFilter>
    id String
    The OCID of the dedicated AI cluster.
    state String
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetDedicatedAiClustersFilter[]
    id string
    The OCID of the dedicated AI cluster.
    state string
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    compartment_id str
    The OCID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[generativeai.GetDedicatedAiClustersFilter]
    id str
    The OCID of the dedicated AI cluster.
    state str
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    id String
    The OCID of the dedicated AI cluster.
    state String
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.

    getDedicatedAiClusters Result

    The following output properties are available:

    CompartmentId string
    The compartment OCID to create the dedicated AI cluster in.
    DedicatedAiClusterCollections List<GetDedicatedAiClustersDedicatedAiClusterCollection>
    The list of dedicated_ai_cluster_collection.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters List<GetDedicatedAiClustersFilter>
    Id string
    The OCID of the dedicated AI cluster.
    State string
    The current state of the dedicated AI cluster.
    CompartmentId string
    The compartment OCID to create the dedicated AI cluster in.
    DedicatedAiClusterCollections []GetDedicatedAiClustersDedicatedAiClusterCollection
    The list of dedicated_ai_cluster_collection.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters []GetDedicatedAiClustersFilter
    Id string
    The OCID of the dedicated AI cluster.
    State string
    The current state of the dedicated AI cluster.
    compartmentId String
    The compartment OCID to create the dedicated AI cluster in.
    dedicatedAiClusterCollections List<GetDedicatedAiClustersDedicatedAiClusterCollection>
    The list of dedicated_ai_cluster_collection.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<GetDedicatedAiClustersFilter>
    id String
    The OCID of the dedicated AI cluster.
    state String
    The current state of the dedicated AI cluster.
    compartmentId string
    The compartment OCID to create the dedicated AI cluster in.
    dedicatedAiClusterCollections GetDedicatedAiClustersDedicatedAiClusterCollection[]
    The list of dedicated_ai_cluster_collection.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters GetDedicatedAiClustersFilter[]
    id string
    The OCID of the dedicated AI cluster.
    state string
    The current state of the dedicated AI cluster.
    compartment_id str
    The compartment OCID to create the dedicated AI cluster in.
    dedicated_ai_cluster_collections Sequence[generativeai.GetDedicatedAiClustersDedicatedAiClusterCollection]
    The list of dedicated_ai_cluster_collection.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters Sequence[generativeai.GetDedicatedAiClustersFilter]
    id str
    The OCID of the dedicated AI cluster.
    state str
    The current state of the dedicated AI cluster.
    compartmentId String
    The compartment OCID to create the dedicated AI cluster in.
    dedicatedAiClusterCollections List<Property Map>
    The list of dedicated_ai_cluster_collection.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<Property Map>
    id String
    The OCID of the dedicated AI cluster.
    state String
    The current state of the dedicated AI cluster.

    Supporting Types

    GetDedicatedAiClustersDedicatedAiClusterCollection

    GetDedicatedAiClustersDedicatedAiClusterCollectionItem

    Capacities List<GetDedicatedAiClustersDedicatedAiClusterCollectionItemCapacity>
    The total capacity for a dedicated AI cluster.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    An optional description of the dedicated AI cluster.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags Dictionary<string, 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. Example: {"Department": "Finance"}
    Id string
    The OCID of the dedicated AI cluster.
    LifecycleDetails string
    A message describing the current state with detail that can provide actionable information.
    State string
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the dedicated AI cluster was created, in the format defined by RFC 3339
    TimeUpdated string
    The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339
    Type string
    The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
    UnitCount int
    The number of dedicated units in this AI cluster.
    UnitShape string
    The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.
    Capacities []GetDedicatedAiClustersDedicatedAiClusterCollectionItemCapacity
    The total capacity for a dedicated AI cluster.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    An optional description of the dedicated AI cluster.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags map[string]interface{}
    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 dedicated AI cluster.
    LifecycleDetails string
    A message describing the current state with detail that can provide actionable information.
    State string
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the dedicated AI cluster was created, in the format defined by RFC 3339
    TimeUpdated string
    The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339
    Type string
    The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
    UnitCount int
    The number of dedicated units in this AI cluster.
    UnitShape string
    The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.
    capacities List<GetDedicatedAiClustersDedicatedAiClusterCollectionItemCapacity>
    The total capacity for a dedicated AI cluster.
    compartmentId String
    The OCID of the compartment in which to list resources.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    An optional description of the dedicated AI cluster.
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String,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. Example: {"Department": "Finance"}
    id String
    The OCID of the dedicated AI cluster.
    lifecycleDetails String
    A message describing the current state with detail that can provide actionable information.
    state String
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the dedicated AI cluster was created, in the format defined by RFC 3339
    timeUpdated String
    The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339
    type String
    The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
    unitCount Integer
    The number of dedicated units in this AI cluster.
    unitShape String
    The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.
    capacities GetDedicatedAiClustersDedicatedAiClusterCollectionItemCapacity[]
    The total capacity for a dedicated AI cluster.
    compartmentId string
    The OCID of the compartment in which to list resources.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    An optional description of the dedicated AI cluster.
    displayName string
    A filter to return only resources that match the given display name exactly.
    freeformTags {[key: string]: any}
    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 dedicated AI cluster.
    lifecycleDetails string
    A message describing the current state with detail that can provide actionable information.
    state string
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the dedicated AI cluster was created, in the format defined by RFC 3339
    timeUpdated string
    The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339
    type string
    The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
    unitCount number
    The number of dedicated units in this AI cluster.
    unitShape string
    The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.
    capacities Sequence[generativeai.GetDedicatedAiClustersDedicatedAiClusterCollectionItemCapacity]
    The total capacity for a dedicated AI cluster.
    compartment_id str
    The OCID of the compartment in which to list resources.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    An optional description of the dedicated AI cluster.
    display_name str
    A filter to return only resources that match the given display name exactly.
    freeform_tags Mapping[str, Any]
    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 dedicated AI cluster.
    lifecycle_details str
    A message describing the current state with detail that can provide actionable information.
    state str
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the dedicated AI cluster was created, in the format defined by RFC 3339
    time_updated str
    The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339
    type str
    The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
    unit_count int
    The number of dedicated units in this AI cluster.
    unit_shape str
    The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.
    capacities List<Property Map>
    The total capacity for a dedicated AI cluster.
    compartmentId String
    The OCID of the compartment in which to list resources.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    An optional description of the dedicated AI cluster.
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<Any>
    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 dedicated AI cluster.
    lifecycleDetails String
    A message describing the current state with detail that can provide actionable information.
    state String
    A filter to return only the dedicated AI clusters that their lifecycle state matches the given lifecycle state.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the dedicated AI cluster was created, in the format defined by RFC 3339
    timeUpdated String
    The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339
    type String
    The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
    unitCount Number
    The number of dedicated units in this AI cluster.
    unitShape String
    The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.

    GetDedicatedAiClustersDedicatedAiClusterCollectionItemCapacity

    CapacityType string
    The type of the dedicated AI cluster capacity.
    TotalEndpointCapacity int
    The total number of endpoints that can be hosted on this dedicated AI cluster.
    UsedEndpointCapacity int
    The number of endpoints hosted on this dedicated AI cluster.
    CapacityType string
    The type of the dedicated AI cluster capacity.
    TotalEndpointCapacity int
    The total number of endpoints that can be hosted on this dedicated AI cluster.
    UsedEndpointCapacity int
    The number of endpoints hosted on this dedicated AI cluster.
    capacityType String
    The type of the dedicated AI cluster capacity.
    totalEndpointCapacity Integer
    The total number of endpoints that can be hosted on this dedicated AI cluster.
    usedEndpointCapacity Integer
    The number of endpoints hosted on this dedicated AI cluster.
    capacityType string
    The type of the dedicated AI cluster capacity.
    totalEndpointCapacity number
    The total number of endpoints that can be hosted on this dedicated AI cluster.
    usedEndpointCapacity number
    The number of endpoints hosted on this dedicated AI cluster.
    capacity_type str
    The type of the dedicated AI cluster capacity.
    total_endpoint_capacity int
    The total number of endpoints that can be hosted on this dedicated AI cluster.
    used_endpoint_capacity int
    The number of endpoints hosted on this dedicated AI cluster.
    capacityType String
    The type of the dedicated AI cluster capacity.
    totalEndpointCapacity Number
    The total number of endpoints that can be hosted on this dedicated AI cluster.
    usedEndpointCapacity Number
    The number of endpoints hosted on this dedicated AI cluster.

    GetDedicatedAiClustersFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi