1. Packages
  2. Gcore Provider
  3. API Docs
  4. getAiCluster
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core

gcore.getAiCluster

Explore with Pulumi AI

gcore logo
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core

    Represent GPU Cluster

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetProjectArgs;
    import com.pulumi.gcore.inputs.GetRegionArgs;
    import com.pulumi.gcore.inputs.GetAiClusterArgs;
    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 pr = GcoreFunctions.getProject(GetProjectArgs.builder()
                .name("test")
                .build());
    
            final var rg = GcoreFunctions.getRegion(GetRegionArgs.builder()
                .name("ED-10 Preprod")
                .build());
    
            final var aiCluster = GcoreFunctions.getAiCluster(GetAiClusterArgs.builder()
                .name("cluster1")
                .regionId(rg.applyValue(getRegionResult -> getRegionResult.id()))
                .projectId(pr.applyValue(getProjectResult -> getProjectResult.id()))
                .build());
    
            ctx.export("view", aiCluster.applyValue(getAiClusterResult -> getAiClusterResult));
        }
    }
    
    variables:
      pr:
        fn::invoke:
          function: gcore:getProject
          arguments:
            name: test
      rg:
        fn::invoke:
          function: gcore:getRegion
          arguments:
            name: ED-10 Preprod
      aiCluster:
        fn::invoke:
          function: gcore:getAiCluster
          arguments:
            name: cluster1
            regionId: ${rg.id}
            projectId: ${pr.id}
    outputs:
      view: ${aiCluster}
    

    Using getAiCluster

    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 getAiCluster(args: GetAiClusterArgs, opts?: InvokeOptions): Promise<GetAiClusterResult>
    function getAiClusterOutput(args: GetAiClusterOutputArgs, opts?: InvokeOptions): Output<GetAiClusterResult>
    def get_ai_cluster(cluster_id: Optional[str] = None,
                       id: Optional[str] = None,
                       project_id: Optional[float] = None,
                       project_name: Optional[str] = None,
                       region_id: Optional[float] = None,
                       region_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAiClusterResult
    def get_ai_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[float]] = None,
                       project_name: Optional[pulumi.Input[str]] = None,
                       region_id: Optional[pulumi.Input[float]] = None,
                       region_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetAiClusterResult]
    func LookupAiCluster(ctx *Context, args *LookupAiClusterArgs, opts ...InvokeOption) (*LookupAiClusterResult, error)
    func LookupAiClusterOutput(ctx *Context, args *LookupAiClusterOutputArgs, opts ...InvokeOption) LookupAiClusterResultOutput

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

    public static class GetAiCluster 
    {
        public static Task<GetAiClusterResult> InvokeAsync(GetAiClusterArgs args, InvokeOptions? opts = null)
        public static Output<GetAiClusterResult> Invoke(GetAiClusterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAiClusterResult> getAiCluster(GetAiClusterArgs args, InvokeOptions options)
    public static Output<GetAiClusterResult> getAiCluster(GetAiClusterArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcore:index/getAiCluster:getAiCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterId string
    AI Cluster ID
    Id string
    The ID of this resource.
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    ClusterId string
    AI Cluster ID
    Id string
    The ID of this resource.
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    clusterId String
    AI Cluster ID
    id String
    The ID of this resource.
    projectId Double
    projectName String
    regionId Double
    regionName String
    clusterId string
    AI Cluster ID
    id string
    The ID of this resource.
    projectId number
    projectName string
    regionId number
    regionName string
    cluster_id str
    AI Cluster ID
    id str
    The ID of this resource.
    project_id float
    project_name str
    region_id float
    region_name str
    clusterId String
    AI Cluster ID
    id String
    The ID of this resource.
    projectId Number
    projectName String
    regionId Number
    regionName String

    getAiCluster Result

    The following output properties are available:

    ClusterId string
    AI Cluster ID
    ClusterMetadata Dictionary<string, string>
    Cluster metadata (simple key-value pairs)
    ClusterName string
    AI Cluster Name
    ClusterStatus string
    AI Cluster status
    CreatedAt string
    Datetime when the cluster was created
    CreatorTaskId string
    Task that created this entity
    Flavor string
    Flavor ID (name)
    Id string
    The ID of this resource.
    ImageId string
    Image ID
    ImageName string
    Image name
    Interfaces List<GetAiClusterInterface>
    Networks managed by user and associated with the cluster
    KeypairName string
    Ssh keypair name
    Password string
    A password for baremetal instance. This parameter is used to set a password for the Admin user on a Windows instance, a default user or a new user on a Linux instance
    PoplarServers List<GetAiClusterPoplarServer>
    GPU cluster servers list
    SecurityGroups List<GetAiClusterSecurityGroup>
    Security groups attached to the cluster
    TaskId string
    Task ID associated with the cluster
    TaskStatus string
    Task status
    UserData string
    String in base64 format. Must not be passed together with 'username' or 'password'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
    Username string
    A name of a new user in the Linux instance. It may be passed with a 'password' parameter
    Volumes List<GetAiClusterVolume>
    List of volumes attached to the cluster
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    ClusterId string
    AI Cluster ID
    ClusterMetadata map[string]string
    Cluster metadata (simple key-value pairs)
    ClusterName string
    AI Cluster Name
    ClusterStatus string
    AI Cluster status
    CreatedAt string
    Datetime when the cluster was created
    CreatorTaskId string
    Task that created this entity
    Flavor string
    Flavor ID (name)
    Id string
    The ID of this resource.
    ImageId string
    Image ID
    ImageName string
    Image name
    Interfaces []GetAiClusterInterface
    Networks managed by user and associated with the cluster
    KeypairName string
    Ssh keypair name
    Password string
    A password for baremetal instance. This parameter is used to set a password for the Admin user on a Windows instance, a default user or a new user on a Linux instance
    PoplarServers []GetAiClusterPoplarServer
    GPU cluster servers list
    SecurityGroups []GetAiClusterSecurityGroup
    Security groups attached to the cluster
    TaskId string
    Task ID associated with the cluster
    TaskStatus string
    Task status
    UserData string
    String in base64 format. Must not be passed together with 'username' or 'password'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
    Username string
    A name of a new user in the Linux instance. It may be passed with a 'password' parameter
    Volumes []GetAiClusterVolume
    List of volumes attached to the cluster
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    clusterId String
    AI Cluster ID
    clusterMetadata Map<String,String>
    Cluster metadata (simple key-value pairs)
    clusterName String
    AI Cluster Name
    clusterStatus String
    AI Cluster status
    createdAt String
    Datetime when the cluster was created
    creatorTaskId String
    Task that created this entity
    flavor String
    Flavor ID (name)
    id String
    The ID of this resource.
    imageId String
    Image ID
    imageName String
    Image name
    interfaces List<GetAiClusterInterface>
    Networks managed by user and associated with the cluster
    keypairName String
    Ssh keypair name
    password String
    A password for baremetal instance. This parameter is used to set a password for the Admin user on a Windows instance, a default user or a new user on a Linux instance
    poplarServers List<GetAiClusterPoplarServer>
    GPU cluster servers list
    securityGroups List<GetAiClusterSecurityGroup>
    Security groups attached to the cluster
    taskId String
    Task ID associated with the cluster
    taskStatus String
    Task status
    userData String
    String in base64 format. Must not be passed together with 'username' or 'password'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
    username String
    A name of a new user in the Linux instance. It may be passed with a 'password' parameter
    volumes List<GetAiClusterVolume>
    List of volumes attached to the cluster
    projectId Double
    projectName String
    regionId Double
    regionName String
    clusterId string
    AI Cluster ID
    clusterMetadata {[key: string]: string}
    Cluster metadata (simple key-value pairs)
    clusterName string
    AI Cluster Name
    clusterStatus string
    AI Cluster status
    createdAt string
    Datetime when the cluster was created
    creatorTaskId string
    Task that created this entity
    flavor string
    Flavor ID (name)
    id string
    The ID of this resource.
    imageId string
    Image ID
    imageName string
    Image name
    interfaces GetAiClusterInterface[]
    Networks managed by user and associated with the cluster
    keypairName string
    Ssh keypair name
    password string
    A password for baremetal instance. This parameter is used to set a password for the Admin user on a Windows instance, a default user or a new user on a Linux instance
    poplarServers GetAiClusterPoplarServer[]
    GPU cluster servers list
    securityGroups GetAiClusterSecurityGroup[]
    Security groups attached to the cluster
    taskId string
    Task ID associated with the cluster
    taskStatus string
    Task status
    userData string
    String in base64 format. Must not be passed together with 'username' or 'password'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
    username string
    A name of a new user in the Linux instance. It may be passed with a 'password' parameter
    volumes GetAiClusterVolume[]
    List of volumes attached to the cluster
    projectId number
    projectName string
    regionId number
    regionName string
    cluster_id str
    AI Cluster ID
    cluster_metadata Mapping[str, str]
    Cluster metadata (simple key-value pairs)
    cluster_name str
    AI Cluster Name
    cluster_status str
    AI Cluster status
    created_at str
    Datetime when the cluster was created
    creator_task_id str
    Task that created this entity
    flavor str
    Flavor ID (name)
    id str
    The ID of this resource.
    image_id str
    Image ID
    image_name str
    Image name
    interfaces Sequence[GetAiClusterInterface]
    Networks managed by user and associated with the cluster
    keypair_name str
    Ssh keypair name
    password str
    A password for baremetal instance. This parameter is used to set a password for the Admin user on a Windows instance, a default user or a new user on a Linux instance
    poplar_servers Sequence[GetAiClusterPoplarServer]
    GPU cluster servers list
    security_groups Sequence[GetAiClusterSecurityGroup]
    Security groups attached to the cluster
    task_id str
    Task ID associated with the cluster
    task_status str
    Task status
    user_data str
    String in base64 format. Must not be passed together with 'username' or 'password'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
    username str
    A name of a new user in the Linux instance. It may be passed with a 'password' parameter
    volumes Sequence[GetAiClusterVolume]
    List of volumes attached to the cluster
    project_id float
    project_name str
    region_id float
    region_name str
    clusterId String
    AI Cluster ID
    clusterMetadata Map<String>
    Cluster metadata (simple key-value pairs)
    clusterName String
    AI Cluster Name
    clusterStatus String
    AI Cluster status
    createdAt String
    Datetime when the cluster was created
    creatorTaskId String
    Task that created this entity
    flavor String
    Flavor ID (name)
    id String
    The ID of this resource.
    imageId String
    Image ID
    imageName String
    Image name
    interfaces List<Property Map>
    Networks managed by user and associated with the cluster
    keypairName String
    Ssh keypair name
    password String
    A password for baremetal instance. This parameter is used to set a password for the Admin user on a Windows instance, a default user or a new user on a Linux instance
    poplarServers List<Property Map>
    GPU cluster servers list
    securityGroups List<Property Map>
    Security groups attached to the cluster
    taskId String
    Task ID associated with the cluster
    taskStatus String
    Task status
    userData String
    String in base64 format. Must not be passed together with 'username' or 'password'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
    username String
    A name of a new user in the Linux instance. It may be passed with a 'password' parameter
    volumes List<Property Map>
    List of volumes attached to the cluster
    projectId Number
    projectName String
    regionId Number
    regionName String

    Supporting Types

    GetAiClusterInterface

    NetworkId string
    PortId string
    SubnetId string
    Type string
    NetworkId string
    PortId string
    SubnetId string
    Type string
    networkId String
    portId String
    subnetId String
    type String
    networkId string
    portId string
    subnetId string
    type string
    networkId String
    portId String
    subnetId String
    type String

    GetAiClusterPoplarServer

    GetAiClusterPoplarServerAddress

    GetAiClusterPoplarServerAddressAddress

    Addr string
    Type string
    Addr string
    Type string
    addr String
    type String
    addr string
    type string
    addr str
    type str
    addr String
    type String

    GetAiClusterPoplarServerSecurityGroup

    Name string
    Name string
    name String
    name string
    name str
    name String

    GetAiClusterPoplarServerVolume

    deleteOnTermination Boolean
    id String
    deleteOnTermination boolean
    id string
    deleteOnTermination Boolean
    id String

    GetAiClusterSecurityGroup

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetAiClusterVolume

    Attachments List<GetAiClusterVolumeAttachment>
    CreatedAt string
    CreatorTaskId string
    ImageId string
    Name string
    Size double
    Source string
    Status string
    UpdatedAt string
    VolumeId string
    VolumeImageMetadata Dictionary<string, string>
    VolumeType string
    attachments GetAiClusterVolumeAttachment[]
    createdAt string
    creatorTaskId string
    imageId string
    name string
    size number
    source string
    status string
    updatedAt string
    volumeId string
    volumeImageMetadata {[key: string]: string}
    volumeType string
    attachments List<Property Map>
    createdAt String
    creatorTaskId String
    imageId String
    name String
    size Number
    source String
    status String
    updatedAt String
    volumeId String
    volumeImageMetadata Map<String>
    volumeType String

    GetAiClusterVolumeAttachment

    AttachedAt string
    AttachmentId string
    Device string
    InstanceName string
    ServerId string
    VolumeId string
    AttachedAt string
    AttachmentId string
    Device string
    InstanceName string
    ServerId string
    VolumeId string
    attachedAt String
    attachmentId String
    device String
    instanceName String
    serverId String
    volumeId String
    attachedAt string
    attachmentId string
    device string
    instanceName string
    serverId string
    volumeId string
    attachedAt String
    attachmentId String
    device String
    instanceName String
    serverId String
    volumeId String

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core