gcore 0.20.0 published on Tuesday, Apr 22, 2025 by g-core
gcore.getAiCluster
Explore with Pulumi AI
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 dictionaryThe following arguments are supported:
- Cluster
Id string - AI Cluster ID
 - Id string
 - The ID of this resource.
 - Project
Id double - Project
Name string - Region
Id double - Region
Name string 
- Cluster
Id string - AI Cluster ID
 - Id string
 - The ID of this resource.
 - Project
Id float64 - Project
Name string - Region
Id float64 - Region
Name string 
- cluster
Id String - AI Cluster ID
 - id String
 - The ID of this resource.
 - project
Id Double - project
Name String - region
Id Double - region
Name String 
- cluster
Id string - AI Cluster ID
 - id string
 - The ID of this resource.
 - project
Id number - project
Name string - region
Id number - region
Name 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 
- cluster
Id String - AI Cluster ID
 - id String
 - The ID of this resource.
 - project
Id Number - project
Name String - region
Id Number - region
Name String 
getAiCluster Result
The following output properties are available:
- Cluster
Id string - AI Cluster ID
 - Cluster
Metadata Dictionary<string, string> - Cluster metadata (simple key-value pairs)
 - Cluster
Name string - AI Cluster Name
 - Cluster
Status string - AI Cluster status
 - Created
At string - Datetime when the cluster was created
 - Creator
Task stringId  - Task that created this entity
 - Flavor string
 - Flavor ID (name)
 - Id string
 - The ID of this resource.
 - Image
Id string - Image ID
 - Image
Name string - Image name
 - Interfaces
List<Get
Ai Cluster Interface>  - Networks managed by user and associated with the cluster
 - Keypair
Name 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
 - Poplar
Servers List<GetAi Cluster Poplar Server>  - GPU cluster servers list
 - Security
Groups List<GetAi Cluster Security Group>  - Security groups attached to the cluster
 - Task
Id string - Task ID associated with the cluster
 - Task
Status string - Task status
 - User
Data 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<Get
Ai Cluster Volume>  - List of volumes attached to the cluster
 - Project
Id double - Project
Name string - Region
Id double - Region
Name string 
- Cluster
Id string - AI Cluster ID
 - Cluster
Metadata map[string]string - Cluster metadata (simple key-value pairs)
 - Cluster
Name string - AI Cluster Name
 - Cluster
Status string - AI Cluster status
 - Created
At string - Datetime when the cluster was created
 - Creator
Task stringId  - Task that created this entity
 - Flavor string
 - Flavor ID (name)
 - Id string
 - The ID of this resource.
 - Image
Id string - Image ID
 - Image
Name string - Image name
 - Interfaces
[]Get
Ai Cluster Interface  - Networks managed by user and associated with the cluster
 - Keypair
Name 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
 - Poplar
Servers []GetAi Cluster Poplar Server  - GPU cluster servers list
 - Security
Groups []GetAi Cluster Security Group  - Security groups attached to the cluster
 - Task
Id string - Task ID associated with the cluster
 - Task
Status string - Task status
 - User
Data 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
[]Get
Ai Cluster Volume  - List of volumes attached to the cluster
 - Project
Id float64 - Project
Name string - Region
Id float64 - Region
Name string 
- cluster
Id String - AI Cluster ID
 - cluster
Metadata Map<String,String> - Cluster metadata (simple key-value pairs)
 - cluster
Name String - AI Cluster Name
 - cluster
Status String - AI Cluster status
 - created
At String - Datetime when the cluster was created
 - creator
Task StringId  - Task that created this entity
 - flavor String
 - Flavor ID (name)
 - id String
 - The ID of this resource.
 - image
Id String - Image ID
 - image
Name String - Image name
 - interfaces
List<Get
Ai Cluster Interface>  - Networks managed by user and associated with the cluster
 - keypair
Name 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
 - poplar
Servers List<GetAi Cluster Poplar Server>  - GPU cluster servers list
 - security
Groups List<GetAi Cluster Security Group>  - Security groups attached to the cluster
 - task
Id String - Task ID associated with the cluster
 - task
Status String - Task status
 - user
Data 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<Get
Ai Cluster Volume>  - List of volumes attached to the cluster
 - project
Id Double - project
Name String - region
Id Double - region
Name String 
- cluster
Id string - AI Cluster ID
 - cluster
Metadata {[key: string]: string} - Cluster metadata (simple key-value pairs)
 - cluster
Name string - AI Cluster Name
 - cluster
Status string - AI Cluster status
 - created
At string - Datetime when the cluster was created
 - creator
Task stringId  - Task that created this entity
 - flavor string
 - Flavor ID (name)
 - id string
 - The ID of this resource.
 - image
Id string - Image ID
 - image
Name string - Image name
 - interfaces
Get
Ai Cluster Interface[]  - Networks managed by user and associated with the cluster
 - keypair
Name 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
 - poplar
Servers GetAi Cluster Poplar Server[]  - GPU cluster servers list
 - security
Groups GetAi Cluster Security Group[]  - Security groups attached to the cluster
 - task
Id string - Task ID associated with the cluster
 - task
Status string - Task status
 - user
Data 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
Get
Ai Cluster Volume[]  - List of volumes attached to the cluster
 - project
Id number - project
Name string - region
Id number - region
Name 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_ strid  - 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[Get
Ai Cluster Interface]  - 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[GetAi Cluster Poplar Server]  - GPU cluster servers list
 - security_
groups Sequence[GetAi Cluster Security Group]  - 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[Get
Ai Cluster Volume]  - List of volumes attached to the cluster
 - project_
id float - project_
name str - region_
id float - region_
name str 
- cluster
Id String - AI Cluster ID
 - cluster
Metadata Map<String> - Cluster metadata (simple key-value pairs)
 - cluster
Name String - AI Cluster Name
 - cluster
Status String - AI Cluster status
 - created
At String - Datetime when the cluster was created
 - creator
Task StringId  - Task that created this entity
 - flavor String
 - Flavor ID (name)
 - id String
 - The ID of this resource.
 - image
Id String - Image ID
 - image
Name String - Image name
 - interfaces List<Property Map>
 - Networks managed by user and associated with the cluster
 - keypair
Name 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
 - poplar
Servers List<Property Map> - GPU cluster servers list
 - security
Groups List<Property Map> - Security groups attached to the cluster
 - task
Id String - Task ID associated with the cluster
 - task
Status String - Task status
 - user
Data 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
 - project
Id Number - project
Name String - region
Id Number - region
Name String 
Supporting Types
GetAiClusterInterface   
- network_
id str - port_
id str - subnet_
id str - type str
 
GetAiClusterPoplarServer    
- Addresses
List<Get
Ai Cluster Poplar Server Address>  - Creator
Task stringId  - Flavor Dictionary<string, string>
 - Flavor
Id string - Instance
Created string - Instance
Description string - Instance
Id string - Instance
Name string - Metadata Dictionary<string, string>
 - Security
Groups List<GetAi Cluster Poplar Server Security Group>  - Status string
 - Task
Id string - Task
State string - Vm
State string - Volumes
List<Get
Ai Cluster Poplar Server Volume>  
- Addresses
[]Get
Ai Cluster Poplar Server Address  - Creator
Task stringId  - Flavor map[string]string
 - Flavor
Id string - Instance
Created string - Instance
Description string - Instance
Id string - Instance
Name string - Metadata map[string]string
 - Security
Groups []GetAi Cluster Poplar Server Security Group  - Status string
 - Task
Id string - Task
State string - Vm
State string - Volumes
[]Get
Ai Cluster Poplar Server Volume  
- addresses
List<Get
Ai Cluster Poplar Server Address>  - creator
Task StringId  - flavor Map<String,String>
 - flavor
Id String - instance
Created String - instance
Description String - instance
Id String - instance
Name String - metadata Map<String,String>
 - security
Groups List<GetAi Cluster Poplar Server Security Group>  - status String
 - task
Id String - task
State String - vm
State String - volumes
List<Get
Ai Cluster Poplar Server Volume>  
- addresses
Get
Ai Cluster Poplar Server Address[]  - creator
Task stringId  - flavor {[key: string]: string}
 - flavor
Id string - instance
Created string - instance
Description string - instance
Id string - instance
Name string - metadata {[key: string]: string}
 - security
Groups GetAi Cluster Poplar Server Security Group[]  - status string
 - task
Id string - task
State string - vm
State string - volumes
Get
Ai Cluster Poplar Server Volume[]  
- addresses
Sequence[Get
Ai Cluster Poplar Server Address]  - creator_
task_ strid  - flavor Mapping[str, str]
 - flavor_
id str - instance_
created str - instance_
description str - instance_
id str - instance_
name str - metadata Mapping[str, str]
 - security_
groups Sequence[GetAi Cluster Poplar Server Security Group]  - status str
 - task_
id str - task_
state str - vm_
state str - volumes
Sequence[Get
Ai Cluster Poplar Server Volume]  
- addresses List<Property Map>
 - creator
Task StringId  - flavor Map<String>
 - flavor
Id String - instance
Created String - instance
Description String - instance
Id String - instance
Name String - metadata Map<String>
 - security
Groups List<Property Map> - status String
 - task
Id String - task
State String - vm
State String - volumes List<Property Map>
 
GetAiClusterPoplarServerAddress     
GetAiClusterPoplarServerAddressAddress      
GetAiClusterPoplarServerSecurityGroup      
- Name string
 
- Name string
 
- name String
 
- name string
 
- name str
 
- name String
 
GetAiClusterPoplarServerVolume     
- Delete
On boolTermination  - Id string
 
- Delete
On boolTermination  - Id string
 
- delete
On BooleanTermination  - id String
 
- delete
On booleanTermination  - id string
 
- delete_
on_ booltermination  - id str
 
- delete
On BooleanTermination  - id String
 
GetAiClusterSecurityGroup    
- Id string
 
- Id string
 
- id String
 
- id string
 
- id str
 
- id String
 
GetAiClusterVolume   
- Attachments
List<Get
Ai Cluster Volume Attachment>  - Created
At string - Creator
Task stringId  - Image
Id string - Name string
 - Size double
 - Source string
 - Status string
 - Updated
At string - Volume
Id string - Volume
Image Dictionary<string, string>Metadata  - Volume
Type string 
- Attachments
[]Get
Ai Cluster Volume Attachment  - Created
At string - Creator
Task stringId  - Image
Id string - Name string
 - Size float64
 - Source string
 - Status string
 - Updated
At string - Volume
Id string - Volume
Image map[string]stringMetadata  - Volume
Type string 
- attachments
List<Get
Ai Cluster Volume Attachment>  - created
At String - creator
Task StringId  - image
Id String - name String
 - size Double
 - source String
 - status String
 - updated
At String - volume
Id String - volume
Image Map<String,String>Metadata  - volume
Type String 
- attachments
Get
Ai Cluster Volume Attachment[]  - created
At string - creator
Task stringId  - image
Id string - name string
 - size number
 - source string
 - status string
 - updated
At string - volume
Id string - volume
Image {[key: string]: string}Metadata  - volume
Type string 
- attachments
Sequence[Get
Ai Cluster Volume Attachment]  - created_
at str - creator_
task_ strid  - image_
id str - name str
 - size float
 - source str
 - status str
 - updated_
at str - volume_
id str - volume_
image_ Mapping[str, str]metadata  - volume_
type str 
- attachments List<Property Map>
 - created
At String - creator
Task StringId  - image
Id String - name String
 - size Number
 - source String
 - status String
 - updated
At String - volume
Id String - volume
Image Map<String>Metadata  - volume
Type String 
GetAiClusterVolumeAttachment    
- Attached
At string - Attachment
Id string - Device string
 - Instance
Name string - Server
Id string - Volume
Id string 
- Attached
At string - Attachment
Id string - Device string
 - Instance
Name string - Server
Id string - Volume
Id string 
- attached
At String - attachment
Id String - device String
 - instance
Name String - server
Id String - volume
Id String 
- attached
At string - attachment
Id string - device string
 - instance
Name string - server
Id string - volume
Id string 
- attached_
at str - attachment_
id str - device str
 - instance_
name str - server_
id str - volume_
id str 
- attached
At String - attachment
Id String - device String
 - instance
Name String - server
Id String - volume
Id String 
Package Details
- Repository
 - gcore g-core/terraform-provider-gcore
 - License
 - Notes
 - This Pulumi package is based on the 
gcoreTerraform Provider.