1. Packages
  2. Qovery
  3. API Docs
  4. getCluster
Qovery v0.41.0 published on Saturday, Sep 28, 2024 by dirien

qovery.getCluster

Explore with Pulumi AI

# qovery.Cluster (Data Source)

Provides a Qovery cluster resource. This can be used to create and manage Qovery cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as qovery from "@pulumi/qovery";

const myCluster = qovery.getCluster({
    id: "<cluster_id>",
    organizationId: "<organization_id>",
});
Copy
import pulumi
import pulumi_qovery as qovery

my_cluster = qovery.get_cluster(id="<cluster_id>",
    organization_id="<organization_id>")
Copy
package main

import (
	"github.com/dirien/pulumi-qovery/sdk/go/qovery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := qovery.LookupCluster(ctx, &qovery.LookupClusterArgs{
			Id:             "<cluster_id>",
			OrganizationId: "<organization_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Qovery = Pulumi.Qovery;

return await Deployment.RunAsync(() => 
{
    var myCluster = Qovery.GetCluster.Invoke(new()
    {
        Id = "<cluster_id>",
        OrganizationId = "<organization_id>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.qovery.QoveryFunctions;
import com.pulumi.qovery.inputs.GetClusterArgs;
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 myCluster = QoveryFunctions.getCluster(GetClusterArgs.builder()
            .id("<cluster_id>")
            .organizationId("<organization_id>")
            .build());

    }
}
Copy
variables:
  myCluster:
    fn::invoke:
      Function: qovery:getCluster
      Arguments:
        id: <cluster_id>
        organizationId: <organization_id>
Copy

Using getCluster

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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
Copy
def get_cluster(advanced_settings_json: Optional[str] = None,
                description: Optional[str] = None,
                disk_size: Optional[int] = None,
                features: Optional[GetClusterFeatures] = None,
                id: Optional[str] = None,
                instance_type: Optional[str] = None,
                kubernetes_mode: Optional[str] = None,
                max_running_nodes: Optional[int] = None,
                min_running_nodes: Optional[int] = None,
                organization_id: Optional[str] = None,
                production: Optional[bool] = None,
                routing_tables: Optional[Sequence[GetClusterRoutingTable]] = None,
                state: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(advanced_settings_json: Optional[pulumi.Input[str]] = None,
                description: Optional[pulumi.Input[str]] = None,
                disk_size: Optional[pulumi.Input[int]] = None,
                features: Optional[pulumi.Input[GetClusterFeaturesArgs]] = None,
                id: Optional[pulumi.Input[str]] = None,
                instance_type: Optional[pulumi.Input[str]] = None,
                kubernetes_mode: Optional[pulumi.Input[str]] = None,
                max_running_nodes: Optional[pulumi.Input[int]] = None,
                min_running_nodes: Optional[pulumi.Input[int]] = None,
                organization_id: Optional[pulumi.Input[str]] = None,
                production: Optional[pulumi.Input[bool]] = None,
                routing_tables: Optional[pulumi.Input[Sequence[pulumi.Input[GetClusterRoutingTableArgs]]]] = None,
                state: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
Copy
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
Copy

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: qovery:index/getCluster:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

id This property is required. String
organizationId This property is required. String
advancedSettingsJson String
description String
diskSize Integer
features GetClusterFeatures
instanceType String
kubernetesMode String
maxRunningNodes Integer
minRunningNodes Integer
production Boolean
routingTables List<GetClusterRoutingTable>
state String
id This property is required. string
organizationId This property is required. string
advancedSettingsJson string
description string
diskSize number
features GetClusterFeatures
instanceType string
kubernetesMode string
maxRunningNodes number
minRunningNodes number
production boolean
routingTables GetClusterRoutingTable[]
state string
id This property is required. String
organizationId This property is required. String
advancedSettingsJson String
description String
diskSize Number
features Property Map
instanceType String
kubernetesMode String
maxRunningNodes Number
minRunningNodes Number
production Boolean
routingTables List<Property Map>
state String

getCluster Result

The following output properties are available:

Supporting Types

GetClusterFeatures

StaticIp This property is required. bool
Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
VpcSubnet This property is required. string
Custom VPC subnet (AWS only) [NOTE: can't be updated after creation]. - Default: 10.0.0.0/16.
ExistingVpc ediri.Qovery.Inputs.GetClusterFeaturesExistingVpc
Network configuration if you want to install qovery on an existing VPC
Karpenter ediri.Qovery.Inputs.GetClusterFeaturesKarpenter
Karpenter parameters if you want to use Karpenter on an EKS cluster
StaticIp This property is required. bool
Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
VpcSubnet This property is required. string
Custom VPC subnet (AWS only) [NOTE: can't be updated after creation]. - Default: 10.0.0.0/16.
ExistingVpc GetClusterFeaturesExistingVpc
Network configuration if you want to install qovery on an existing VPC
Karpenter GetClusterFeaturesKarpenter
Karpenter parameters if you want to use Karpenter on an EKS cluster
staticIp This property is required. Boolean
Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
vpcSubnet This property is required. String
Custom VPC subnet (AWS only) [NOTE: can't be updated after creation]. - Default: 10.0.0.0/16.
existingVpc GetClusterFeaturesExistingVpc
Network configuration if you want to install qovery on an existing VPC
karpenter GetClusterFeaturesKarpenter
Karpenter parameters if you want to use Karpenter on an EKS cluster
staticIp This property is required. boolean
Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
vpcSubnet This property is required. string
Custom VPC subnet (AWS only) [NOTE: can't be updated after creation]. - Default: 10.0.0.0/16.
existingVpc GetClusterFeaturesExistingVpc
Network configuration if you want to install qovery on an existing VPC
karpenter GetClusterFeaturesKarpenter
Karpenter parameters if you want to use Karpenter on an EKS cluster
static_ip This property is required. bool
Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
vpc_subnet This property is required. str
Custom VPC subnet (AWS only) [NOTE: can't be updated after creation]. - Default: 10.0.0.0/16.
existing_vpc GetClusterFeaturesExistingVpc
Network configuration if you want to install qovery on an existing VPC
karpenter GetClusterFeaturesKarpenter
Karpenter parameters if you want to use Karpenter on an EKS cluster
staticIp This property is required. Boolean
Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
vpcSubnet This property is required. String
Custom VPC subnet (AWS only) [NOTE: can't be updated after creation]. - Default: 10.0.0.0/16.
existingVpc Property Map
Network configuration if you want to install qovery on an existing VPC
karpenter Property Map
Karpenter parameters if you want to use Karpenter on an EKS cluster

GetClusterFeaturesExistingVpc

AwsVpcEksId This property is required. string
Aws VPC id
DocumentdbSubnetsZoneAIds This property is required. List<string>
Ids of the subnets for document db
DocumentdbSubnetsZoneBIds This property is required. List<string>
Ids of the subnets for document db
DocumentdbSubnetsZoneCIds This property is required. List<string>
Ids of the subnets for document db
EksSubnetsZoneAIds This property is required. List<string>
Ids of the subnets for EKS zone a. Must have map_public_ip_on_launch set to true
EksSubnetsZoneBIds This property is required. List<string>
Ids of the subnets for EKS zone b. Must have map_public_ip_on_launch set to true
EksSubnetsZoneCIds This property is required. List<string>
Ids of the subnets for EKS zone c. Must have map_public_ip_on_launch set to true
ElasticacheSubnetsZoneAIds This property is required. List<string>
Ids of the subnets for elasticache
ElasticacheSubnetsZoneBIds This property is required. List<string>
Ids of the subnets for elasticache
ElasticacheSubnetsZoneCIds This property is required. List<string>
Ids of the subnets for elasticache
RdsSubnetsZoneAIds This property is required. List<string>
Ids of the subnets for RDS
RdsSubnetsZoneBIds This property is required. List<string>
Ids of the subnets for RDS
RdsSubnetsZoneCIds This property is required. List<string>
Ids of the subnets for RDS
AwsVpcEksId This property is required. string
Aws VPC id
DocumentdbSubnetsZoneAIds This property is required. []string
Ids of the subnets for document db
DocumentdbSubnetsZoneBIds This property is required. []string
Ids of the subnets for document db
DocumentdbSubnetsZoneCIds This property is required. []string
Ids of the subnets for document db
EksSubnetsZoneAIds This property is required. []string
Ids of the subnets for EKS zone a. Must have map_public_ip_on_launch set to true
EksSubnetsZoneBIds This property is required. []string
Ids of the subnets for EKS zone b. Must have map_public_ip_on_launch set to true
EksSubnetsZoneCIds This property is required. []string
Ids of the subnets for EKS zone c. Must have map_public_ip_on_launch set to true
ElasticacheSubnetsZoneAIds This property is required. []string
Ids of the subnets for elasticache
ElasticacheSubnetsZoneBIds This property is required. []string
Ids of the subnets for elasticache
ElasticacheSubnetsZoneCIds This property is required. []string
Ids of the subnets for elasticache
RdsSubnetsZoneAIds This property is required. []string
Ids of the subnets for RDS
RdsSubnetsZoneBIds This property is required. []string
Ids of the subnets for RDS
RdsSubnetsZoneCIds This property is required. []string
Ids of the subnets for RDS
awsVpcEksId This property is required. String
Aws VPC id
documentdbSubnetsZoneAIds This property is required. List<String>
Ids of the subnets for document db
documentdbSubnetsZoneBIds This property is required. List<String>
Ids of the subnets for document db
documentdbSubnetsZoneCIds This property is required. List<String>
Ids of the subnets for document db
eksSubnetsZoneAIds This property is required. List<String>
Ids of the subnets for EKS zone a. Must have map_public_ip_on_launch set to true
eksSubnetsZoneBIds This property is required. List<String>
Ids of the subnets for EKS zone b. Must have map_public_ip_on_launch set to true
eksSubnetsZoneCIds This property is required. List<String>
Ids of the subnets for EKS zone c. Must have map_public_ip_on_launch set to true
elasticacheSubnetsZoneAIds This property is required. List<String>
Ids of the subnets for elasticache
elasticacheSubnetsZoneBIds This property is required. List<String>
Ids of the subnets for elasticache
elasticacheSubnetsZoneCIds This property is required. List<String>
Ids of the subnets for elasticache
rdsSubnetsZoneAIds This property is required. List<String>
Ids of the subnets for RDS
rdsSubnetsZoneBIds This property is required. List<String>
Ids of the subnets for RDS
rdsSubnetsZoneCIds This property is required. List<String>
Ids of the subnets for RDS
awsVpcEksId This property is required. string
Aws VPC id
documentdbSubnetsZoneAIds This property is required. string[]
Ids of the subnets for document db
documentdbSubnetsZoneBIds This property is required. string[]
Ids of the subnets for document db
documentdbSubnetsZoneCIds This property is required. string[]
Ids of the subnets for document db
eksSubnetsZoneAIds This property is required. string[]
Ids of the subnets for EKS zone a. Must have map_public_ip_on_launch set to true
eksSubnetsZoneBIds This property is required. string[]
Ids of the subnets for EKS zone b. Must have map_public_ip_on_launch set to true
eksSubnetsZoneCIds This property is required. string[]
Ids of the subnets for EKS zone c. Must have map_public_ip_on_launch set to true
elasticacheSubnetsZoneAIds This property is required. string[]
Ids of the subnets for elasticache
elasticacheSubnetsZoneBIds This property is required. string[]
Ids of the subnets for elasticache
elasticacheSubnetsZoneCIds This property is required. string[]
Ids of the subnets for elasticache
rdsSubnetsZoneAIds This property is required. string[]
Ids of the subnets for RDS
rdsSubnetsZoneBIds This property is required. string[]
Ids of the subnets for RDS
rdsSubnetsZoneCIds This property is required. string[]
Ids of the subnets for RDS
aws_vpc_eks_id This property is required. str
Aws VPC id
documentdb_subnets_zone_a_ids This property is required. Sequence[str]
Ids of the subnets for document db
documentdb_subnets_zone_b_ids This property is required. Sequence[str]
Ids of the subnets for document db
documentdb_subnets_zone_c_ids This property is required. Sequence[str]
Ids of the subnets for document db
eks_subnets_zone_a_ids This property is required. Sequence[str]
Ids of the subnets for EKS zone a. Must have map_public_ip_on_launch set to true
eks_subnets_zone_b_ids This property is required. Sequence[str]
Ids of the subnets for EKS zone b. Must have map_public_ip_on_launch set to true
eks_subnets_zone_c_ids This property is required. Sequence[str]
Ids of the subnets for EKS zone c. Must have map_public_ip_on_launch set to true
elasticache_subnets_zone_a_ids This property is required. Sequence[str]
Ids of the subnets for elasticache
elasticache_subnets_zone_b_ids This property is required. Sequence[str]
Ids of the subnets for elasticache
elasticache_subnets_zone_c_ids This property is required. Sequence[str]
Ids of the subnets for elasticache
rds_subnets_zone_a_ids This property is required. Sequence[str]
Ids of the subnets for RDS
rds_subnets_zone_b_ids This property is required. Sequence[str]
Ids of the subnets for RDS
rds_subnets_zone_c_ids This property is required. Sequence[str]
Ids of the subnets for RDS
awsVpcEksId This property is required. String
Aws VPC id
documentdbSubnetsZoneAIds This property is required. List<String>
Ids of the subnets for document db
documentdbSubnetsZoneBIds This property is required. List<String>
Ids of the subnets for document db
documentdbSubnetsZoneCIds This property is required. List<String>
Ids of the subnets for document db
eksSubnetsZoneAIds This property is required. List<String>
Ids of the subnets for EKS zone a. Must have map_public_ip_on_launch set to true
eksSubnetsZoneBIds This property is required. List<String>
Ids of the subnets for EKS zone b. Must have map_public_ip_on_launch set to true
eksSubnetsZoneCIds This property is required. List<String>
Ids of the subnets for EKS zone c. Must have map_public_ip_on_launch set to true
elasticacheSubnetsZoneAIds This property is required. List<String>
Ids of the subnets for elasticache
elasticacheSubnetsZoneBIds This property is required. List<String>
Ids of the subnets for elasticache
elasticacheSubnetsZoneCIds This property is required. List<String>
Ids of the subnets for elasticache
rdsSubnetsZoneAIds This property is required. List<String>
Ids of the subnets for RDS
rdsSubnetsZoneBIds This property is required. List<String>
Ids of the subnets for RDS
rdsSubnetsZoneCIds This property is required. List<String>
Ids of the subnets for RDS

GetClusterFeaturesKarpenter

DefaultServiceArchitecture This property is required. string
The default architecture of service
DiskSizeInGib This property is required. int
SpotEnabled This property is required. bool
Enable spot instances
DefaultServiceArchitecture This property is required. string
The default architecture of service
DiskSizeInGib This property is required. int
SpotEnabled This property is required. bool
Enable spot instances
defaultServiceArchitecture This property is required. String
The default architecture of service
diskSizeInGib This property is required. Integer
spotEnabled This property is required. Boolean
Enable spot instances
defaultServiceArchitecture This property is required. string
The default architecture of service
diskSizeInGib This property is required. number
spotEnabled This property is required. boolean
Enable spot instances
default_service_architecture This property is required. str
The default architecture of service
disk_size_in_gib This property is required. int
spot_enabled This property is required. bool
Enable spot instances
defaultServiceArchitecture This property is required. String
The default architecture of service
diskSizeInGib This property is required. Number
spotEnabled This property is required. Boolean
Enable spot instances

GetClusterRoutingTable

Description This property is required. string
Description of the route.
Destination This property is required. string
Destination of the route.
Target This property is required. string
Target of the route.
Description This property is required. string
Description of the route.
Destination This property is required. string
Destination of the route.
Target This property is required. string
Target of the route.
description This property is required. String
Description of the route.
destination This property is required. String
Destination of the route.
target This property is required. String
Target of the route.
description This property is required. string
Description of the route.
destination This property is required. string
Destination of the route.
target This property is required. string
Target of the route.
description This property is required. str
Description of the route.
destination This property is required. str
Destination of the route.
target This property is required. str
Target of the route.
description This property is required. String
Description of the route.
destination This property is required. String
Destination of the route.
target This property is required. String
Target of the route.

Package Details

Repository
qovery dirien/pulumi-qovery
License
Apache-2.0
Notes
This Pulumi package is based on the qovery Terraform Provider.