1. Packages
  2. Qovery
  3. API Docs
  4. getCluster
Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien

qovery.getCluster

Explore with Pulumi AI

qovery logo
Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien

    # qovery.Cluster (Data Source)

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

    Example Usage

    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>",
        });
    
    });
    
    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
    	})
    }
    
    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());
    
        }
    }
    
    import pulumi
    import pulumi_qovery as qovery
    
    my_cluster = qovery.get_cluster(id="<cluster_id>",
        organization_id="<organization_id>")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as qovery from "@pulumi/qovery";
    
    const myCluster = qovery.getCluster({
        id: "<cluster_id>",
        organizationId: "<organization_id>",
    });
    
    variables:
      myCluster:
        fn::invoke:
          Function: qovery:getCluster
          Arguments:
            id: <cluster_id>
            organizationId: <organization_id>
    

    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>
    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,
                    kubernetes_mode: Optional[str] = None,
                    max_running_nodes: Optional[int] = None,
                    min_running_nodes: Optional[int] = None,
                    organization_id: Optional[str] = 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,
                    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,
                    routing_tables: Optional[pulumi.Input[Sequence[pulumi.Input[GetClusterRoutingTableArgs]]]] = None,
                    state: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
    func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > 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)
    }
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: qovery:index/getCluster:getCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getCluster Result

    The following output properties are available:

    Supporting Types

    GetClusterFeatures

    StaticIp bool
    Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
    VpcSubnet 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
    StaticIp bool
    Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
    VpcSubnet 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
    staticIp Boolean
    Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
    vpcSubnet 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
    staticIp boolean
    Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
    vpcSubnet 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
    static_ip bool
    Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
    vpc_subnet 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
    staticIp Boolean
    Static IP (AWS only) [NOTE: can't be updated after creation]. - Default: false.
    vpcSubnet 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

    GetClusterFeaturesExistingVpc

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

    GetClusterRoutingTable

    Description string
    Description of the route.
    Destination string
    Destination of the route.
    Target string
    Target of the route.
    Description string
    Description of the route.
    Destination string
    Destination of the route.
    Target string
    Target of the route.
    description String
    Description of the route.
    destination String
    Destination of the route.
    target String
    Target of the route.
    description string
    Description of the route.
    destination string
    Destination of the route.
    target string
    Target of the route.
    description str
    Description of the route.
    destination str
    Destination of the route.
    target str
    Target of the route.
    description String
    Description of the route.
    destination String
    Destination of the route.
    target 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.
    qovery logo
    Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien