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

qovery.Cluster

Explore with Pulumi AI

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

    # qovery.Cluster (Resource)

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

    Example

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.qovery.Cluster;
    import com.pulumi.qovery.ClusterArgs;
    import com.pulumi.qovery.inputs.ClusterFeaturesArgs;
    import com.pulumi.qovery.inputs.ClusterRoutingTableArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    import com.pulumi.resources.CustomResourceOptions;
    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) {
            var myCluster = new Cluster("myCluster", ClusterArgs.builder()        
                .organizationId(qovery_organization.my_organization().id())
                .credentialsId(qovery_aws_credentials.my_aws_creds().id())
                .cloudProvider("AWS")
                .region("eu-west-3")
                .instanceType("T3A_MEDIUM")
                .description("My cluster description")
                .minRunningNodes(3)
                .maxRunningNodes(10)
                .features(ClusterFeaturesArgs.builder()
                    .vpc_subnet("10.0.0.0/16")
                    .build())
                .routingTables(ClusterRoutingTableArgs.builder()
                    .description("RDS database peering")
                    .destination("172.30.0.0/16")
                    .target("pcx-06f8f5512c91e389c")
                    .build())
                .advancedSettingsJson(serializeJson(
                    jsonObject(
                        jsonProperty("aws.vpc.flow_logs_retention_days", 100),
                        jsonProperty("aws.vpc.enable_s3_flow_logs", true)
                    )))
                .state("DEPLOYED")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(                
                        qovery_organization.my_organization(),
                        qovery_aws_credentials.my_aws_creds())
                    .build());
    
        }
    }
    
    resources:
      myCluster:
        type: qovery:Cluster
        properties:
          # Required
          organizationId: ${qovery_organization.my_organization.id}
          credentialsId: ${qovery_aws_credentials.my_aws_creds.id}
          cloudProvider: AWS
          region: eu-west-3
          instanceType: T3A_MEDIUM
          # Optional
          description: My cluster description
          minRunningNodes: 3
          maxRunningNodes: 10
          features:
            vpc_subnet: 10.0.0.0/16
          routingTables:
            - description: RDS database peering
              destination: 172.30.0.0/16
              target: pcx-06f8f5512c91e389c
          advancedSettingsJson:
            fn::toJSON:
              aws.vpc.flow_logs_retention_days: 100
              aws.vpc.enable_s3_flow_logs: true
          state: DEPLOYED
        options:
          dependson:
            - ${qovery_organization.my_organization}
            - ${qovery_aws_credentials.my_aws_creds}
    

    You can find complete examples within these repositories:

    • Deploy an Application and Database within 3 environments

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                instance_type: Optional[str] = None,
                cloud_provider: Optional[str] = None,
                credentials_id: Optional[str] = None,
                region: Optional[str] = None,
                organization_id: Optional[str] = None,
                description: Optional[str] = None,
                features: Optional[ClusterFeaturesArgs] = None,
                kubernetes_mode: Optional[str] = None,
                max_running_nodes: Optional[int] = None,
                min_running_nodes: Optional[int] = None,
                name: Optional[str] = None,
                disk_size: Optional[int] = None,
                advanced_settings_json: Optional[str] = None,
                routing_tables: Optional[Sequence[ClusterRoutingTableArgs]] = None,
                state: Optional[str] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: qovery:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var clusterResource = new Qovery.Cluster("clusterResource", new()
    {
        InstanceType = "string",
        CloudProvider = "string",
        CredentialsId = "string",
        Region = "string",
        OrganizationId = "string",
        Description = "string",
        Features = new Qovery.Inputs.ClusterFeaturesArgs
        {
            ExistingVpc = new Qovery.Inputs.ClusterFeaturesExistingVpcArgs
            {
                EksSubnetsZoneAIds = new[]
                {
                    "string",
                },
                EksSubnetsZoneCIds = new[]
                {
                    "string",
                },
                EksSubnetsZoneBIds = new[]
                {
                    "string",
                },
                AwsVpcEksId = "string",
                DocumentdbSubnetsZoneCIds = new[]
                {
                    "string",
                },
                DocumentdbSubnetsZoneBIds = new[]
                {
                    "string",
                },
                DocumentdbSubnetsZoneAIds = new[]
                {
                    "string",
                },
                ElasticacheSubnetsZoneAIds = new[]
                {
                    "string",
                },
                ElasticacheSubnetsZoneBIds = new[]
                {
                    "string",
                },
                ElasticacheSubnetsZoneCIds = new[]
                {
                    "string",
                },
                RdsSubnetsZoneAIds = new[]
                {
                    "string",
                },
                RdsSubnetsZoneBIds = new[]
                {
                    "string",
                },
                RdsSubnetsZoneCIds = new[]
                {
                    "string",
                },
            },
            StaticIp = false,
            VpcSubnet = "string",
        },
        KubernetesMode = "string",
        MaxRunningNodes = 0,
        MinRunningNodes = 0,
        Name = "string",
        DiskSize = 0,
        AdvancedSettingsJson = "string",
        RoutingTables = new[]
        {
            new Qovery.Inputs.ClusterRoutingTableArgs
            {
                Description = "string",
                Destination = "string",
                Target = "string",
            },
        },
        State = "string",
    });
    
    example, err := qovery.NewCluster(ctx, "clusterResource", &qovery.ClusterArgs{
    	InstanceType:   pulumi.String("string"),
    	CloudProvider:  pulumi.String("string"),
    	CredentialsId:  pulumi.String("string"),
    	Region:         pulumi.String("string"),
    	OrganizationId: pulumi.String("string"),
    	Description:    pulumi.String("string"),
    	Features: &qovery.ClusterFeaturesArgs{
    		ExistingVpc: &qovery.ClusterFeaturesExistingVpcArgs{
    			EksSubnetsZoneAIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			EksSubnetsZoneCIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			EksSubnetsZoneBIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			AwsVpcEksId: pulumi.String("string"),
    			DocumentdbSubnetsZoneCIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			DocumentdbSubnetsZoneBIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			DocumentdbSubnetsZoneAIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			ElasticacheSubnetsZoneAIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			ElasticacheSubnetsZoneBIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			ElasticacheSubnetsZoneCIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			RdsSubnetsZoneAIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			RdsSubnetsZoneBIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			RdsSubnetsZoneCIds: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    		StaticIp:  pulumi.Bool(false),
    		VpcSubnet: pulumi.String("string"),
    	},
    	KubernetesMode:       pulumi.String("string"),
    	MaxRunningNodes:      pulumi.Int(0),
    	MinRunningNodes:      pulumi.Int(0),
    	Name:                 pulumi.String("string"),
    	DiskSize:             pulumi.Int(0),
    	AdvancedSettingsJson: pulumi.String("string"),
    	RoutingTables: qovery.ClusterRoutingTableArray{
    		&qovery.ClusterRoutingTableArgs{
    			Description: pulumi.String("string"),
    			Destination: pulumi.String("string"),
    			Target:      pulumi.String("string"),
    		},
    	},
    	State: pulumi.String("string"),
    })
    
    var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()        
        .instanceType("string")
        .cloudProvider("string")
        .credentialsId("string")
        .region("string")
        .organizationId("string")
        .description("string")
        .features(ClusterFeaturesArgs.builder()
            .existingVpc(ClusterFeaturesExistingVpcArgs.builder()
                .eksSubnetsZoneAIds("string")
                .eksSubnetsZoneCIds("string")
                .eksSubnetsZoneBIds("string")
                .awsVpcEksId("string")
                .documentdbSubnetsZoneCIds("string")
                .documentdbSubnetsZoneBIds("string")
                .documentdbSubnetsZoneAIds("string")
                .elasticacheSubnetsZoneAIds("string")
                .elasticacheSubnetsZoneBIds("string")
                .elasticacheSubnetsZoneCIds("string")
                .rdsSubnetsZoneAIds("string")
                .rdsSubnetsZoneBIds("string")
                .rdsSubnetsZoneCIds("string")
                .build())
            .staticIp(false)
            .vpcSubnet("string")
            .build())
        .kubernetesMode("string")
        .maxRunningNodes(0)
        .minRunningNodes(0)
        .name("string")
        .diskSize(0)
        .advancedSettingsJson("string")
        .routingTables(ClusterRoutingTableArgs.builder()
            .description("string")
            .destination("string")
            .target("string")
            .build())
        .state("string")
        .build());
    
    cluster_resource = qovery.Cluster("clusterResource",
        instance_type="string",
        cloud_provider="string",
        credentials_id="string",
        region="string",
        organization_id="string",
        description="string",
        features=qovery.ClusterFeaturesArgs(
            existing_vpc=qovery.ClusterFeaturesExistingVpcArgs(
                eks_subnets_zone_a_ids=["string"],
                eks_subnets_zone_c_ids=["string"],
                eks_subnets_zone_b_ids=["string"],
                aws_vpc_eks_id="string",
                documentdb_subnets_zone_c_ids=["string"],
                documentdb_subnets_zone_b_ids=["string"],
                documentdb_subnets_zone_a_ids=["string"],
                elasticache_subnets_zone_a_ids=["string"],
                elasticache_subnets_zone_b_ids=["string"],
                elasticache_subnets_zone_c_ids=["string"],
                rds_subnets_zone_a_ids=["string"],
                rds_subnets_zone_b_ids=["string"],
                rds_subnets_zone_c_ids=["string"],
            ),
            static_ip=False,
            vpc_subnet="string",
        ),
        kubernetes_mode="string",
        max_running_nodes=0,
        min_running_nodes=0,
        name="string",
        disk_size=0,
        advanced_settings_json="string",
        routing_tables=[qovery.ClusterRoutingTableArgs(
            description="string",
            destination="string",
            target="string",
        )],
        state="string")
    
    const clusterResource = new qovery.Cluster("clusterResource", {
        instanceType: "string",
        cloudProvider: "string",
        credentialsId: "string",
        region: "string",
        organizationId: "string",
        description: "string",
        features: {
            existingVpc: {
                eksSubnetsZoneAIds: ["string"],
                eksSubnetsZoneCIds: ["string"],
                eksSubnetsZoneBIds: ["string"],
                awsVpcEksId: "string",
                documentdbSubnetsZoneCIds: ["string"],
                documentdbSubnetsZoneBIds: ["string"],
                documentdbSubnetsZoneAIds: ["string"],
                elasticacheSubnetsZoneAIds: ["string"],
                elasticacheSubnetsZoneBIds: ["string"],
                elasticacheSubnetsZoneCIds: ["string"],
                rdsSubnetsZoneAIds: ["string"],
                rdsSubnetsZoneBIds: ["string"],
                rdsSubnetsZoneCIds: ["string"],
            },
            staticIp: false,
            vpcSubnet: "string",
        },
        kubernetesMode: "string",
        maxRunningNodes: 0,
        minRunningNodes: 0,
        name: "string",
        diskSize: 0,
        advancedSettingsJson: "string",
        routingTables: [{
            description: "string",
            destination: "string",
            target: "string",
        }],
        state: "string",
    });
    
    type: qovery:Cluster
    properties:
        advancedSettingsJson: string
        cloudProvider: string
        credentialsId: string
        description: string
        diskSize: 0
        features:
            existingVpc:
                awsVpcEksId: string
                documentdbSubnetsZoneAIds:
                    - string
                documentdbSubnetsZoneBIds:
                    - string
                documentdbSubnetsZoneCIds:
                    - string
                eksSubnetsZoneAIds:
                    - string
                eksSubnetsZoneBIds:
                    - string
                eksSubnetsZoneCIds:
                    - string
                elasticacheSubnetsZoneAIds:
                    - string
                elasticacheSubnetsZoneBIds:
                    - string
                elasticacheSubnetsZoneCIds:
                    - string
                rdsSubnetsZoneAIds:
                    - string
                rdsSubnetsZoneBIds:
                    - string
                rdsSubnetsZoneCIds:
                    - string
            staticIp: false
            vpcSubnet: string
        instanceType: string
        kubernetesMode: string
        maxRunningNodes: 0
        minRunningNodes: 0
        name: string
        organizationId: string
        region: string
        routingTables:
            - description: string
              destination: string
              target: string
        state: string
    

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Cluster resource accepts the following input properties:

    CloudProvider string
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    CredentialsId string
    Id of the credentials.
    InstanceType string
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    OrganizationId string
    Id of the organization.
    Region string
    Region of the cluster.
    AdvancedSettingsJson string
    Advanced settings of the cluster.
    Description string
    Description of the cluster. - Default: ``.
    DiskSize int
    Features ediri.Qovery.Inputs.ClusterFeatures
    Features of the cluster.
    KubernetesMode string
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    MaxRunningNodes int
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    MinRunningNodes int
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    Name string
    Name of the cluster.
    RoutingTables List<ediri.Qovery.Inputs.ClusterRoutingTable>
    List of routes of the cluster.
    State string
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    CloudProvider string
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    CredentialsId string
    Id of the credentials.
    InstanceType string
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    OrganizationId string
    Id of the organization.
    Region string
    Region of the cluster.
    AdvancedSettingsJson string
    Advanced settings of the cluster.
    Description string
    Description of the cluster. - Default: ``.
    DiskSize int
    Features ClusterFeaturesArgs
    Features of the cluster.
    KubernetesMode string
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    MaxRunningNodes int
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    MinRunningNodes int
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    Name string
    Name of the cluster.
    RoutingTables []ClusterRoutingTableArgs
    List of routes of the cluster.
    State string
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    cloudProvider String
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    credentialsId String
    Id of the credentials.
    instanceType String
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    organizationId String
    Id of the organization.
    region String
    Region of the cluster.
    advancedSettingsJson String
    Advanced settings of the cluster.
    description String
    Description of the cluster. - Default: ``.
    diskSize Integer
    features ClusterFeatures
    Features of the cluster.
    kubernetesMode String
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    maxRunningNodes Integer
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    minRunningNodes Integer
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    name String
    Name of the cluster.
    routingTables List<ClusterRoutingTable>
    List of routes of the cluster.
    state String
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    cloudProvider string
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    credentialsId string
    Id of the credentials.
    instanceType string
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    organizationId string
    Id of the organization.
    region string
    Region of the cluster.
    advancedSettingsJson string
    Advanced settings of the cluster.
    description string
    Description of the cluster. - Default: ``.
    diskSize number
    features ClusterFeatures
    Features of the cluster.
    kubernetesMode string
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    maxRunningNodes number
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    minRunningNodes number
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    name string
    Name of the cluster.
    routingTables ClusterRoutingTable[]
    List of routes of the cluster.
    state string
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    cloud_provider str
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    credentials_id str
    Id of the credentials.
    instance_type str
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    organization_id str
    Id of the organization.
    region str
    Region of the cluster.
    advanced_settings_json str
    Advanced settings of the cluster.
    description str
    Description of the cluster. - Default: ``.
    disk_size int
    features ClusterFeaturesArgs
    Features of the cluster.
    kubernetes_mode str
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    max_running_nodes int
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    min_running_nodes int
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    name str
    Name of the cluster.
    routing_tables Sequence[ClusterRoutingTableArgs]
    List of routes of the cluster.
    state str
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    cloudProvider String
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    credentialsId String
    Id of the credentials.
    instanceType String
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    organizationId String
    Id of the organization.
    region String
    Region of the cluster.
    advancedSettingsJson String
    Advanced settings of the cluster.
    description String
    Description of the cluster. - Default: ``.
    diskSize Number
    features Property Map
    Features of the cluster.
    kubernetesMode String
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    maxRunningNodes Number
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    minRunningNodes Number
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    name String
    Name of the cluster.
    routingTables List<Property Map>
    List of routes of the cluster.
    state String
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Cluster Resource

    Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            advanced_settings_json: Optional[str] = None,
            cloud_provider: Optional[str] = None,
            credentials_id: Optional[str] = None,
            description: Optional[str] = None,
            disk_size: Optional[int] = None,
            features: Optional[ClusterFeaturesArgs] = None,
            instance_type: Optional[str] = None,
            kubernetes_mode: Optional[str] = None,
            max_running_nodes: Optional[int] = None,
            min_running_nodes: Optional[int] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            region: Optional[str] = None,
            routing_tables: Optional[Sequence[ClusterRoutingTableArgs]] = None,
            state: Optional[str] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdvancedSettingsJson string
    Advanced settings of the cluster.
    CloudProvider string
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    CredentialsId string
    Id of the credentials.
    Description string
    Description of the cluster. - Default: ``.
    DiskSize int
    Features ediri.Qovery.Inputs.ClusterFeatures
    Features of the cluster.
    InstanceType string
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    KubernetesMode string
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    MaxRunningNodes int
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    MinRunningNodes int
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    Name string
    Name of the cluster.
    OrganizationId string
    Id of the organization.
    Region string
    Region of the cluster.
    RoutingTables List<ediri.Qovery.Inputs.ClusterRoutingTable>
    List of routes of the cluster.
    State string
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    AdvancedSettingsJson string
    Advanced settings of the cluster.
    CloudProvider string
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    CredentialsId string
    Id of the credentials.
    Description string
    Description of the cluster. - Default: ``.
    DiskSize int
    Features ClusterFeaturesArgs
    Features of the cluster.
    InstanceType string
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    KubernetesMode string
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    MaxRunningNodes int
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    MinRunningNodes int
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    Name string
    Name of the cluster.
    OrganizationId string
    Id of the organization.
    Region string
    Region of the cluster.
    RoutingTables []ClusterRoutingTableArgs
    List of routes of the cluster.
    State string
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    advancedSettingsJson String
    Advanced settings of the cluster.
    cloudProvider String
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    credentialsId String
    Id of the credentials.
    description String
    Description of the cluster. - Default: ``.
    diskSize Integer
    features ClusterFeatures
    Features of the cluster.
    instanceType String
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    kubernetesMode String
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    maxRunningNodes Integer
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    minRunningNodes Integer
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    name String
    Name of the cluster.
    organizationId String
    Id of the organization.
    region String
    Region of the cluster.
    routingTables List<ClusterRoutingTable>
    List of routes of the cluster.
    state String
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    advancedSettingsJson string
    Advanced settings of the cluster.
    cloudProvider string
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    credentialsId string
    Id of the credentials.
    description string
    Description of the cluster. - Default: ``.
    diskSize number
    features ClusterFeatures
    Features of the cluster.
    instanceType string
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    kubernetesMode string
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    maxRunningNodes number
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    minRunningNodes number
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    name string
    Name of the cluster.
    organizationId string
    Id of the organization.
    region string
    Region of the cluster.
    routingTables ClusterRoutingTable[]
    List of routes of the cluster.
    state string
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    advanced_settings_json str
    Advanced settings of the cluster.
    cloud_provider str
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    credentials_id str
    Id of the credentials.
    description str
    Description of the cluster. - Default: ``.
    disk_size int
    features ClusterFeaturesArgs
    Features of the cluster.
    instance_type str
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    kubernetes_mode str
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    max_running_nodes int
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    min_running_nodes int
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    name str
    Name of the cluster.
    organization_id str
    Id of the organization.
    region str
    Region of the cluster.
    routing_tables Sequence[ClusterRoutingTableArgs]
    List of routes of the cluster.
    state str
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.
    advancedSettingsJson String
    Advanced settings of the cluster.
    cloudProvider String
    Cloud provider of the cluster. - Can be: AWS, GCP, SCW.
    credentialsId String
    Id of the credentials.
    description String
    Description of the cluster. - Default: ``.
    diskSize Number
    features Property Map
    Features of the cluster.
    instanceType String
    Instance type of the cluster. I.e: For Aws t3a.xlarge, for Scaleway DEV-L
    kubernetesMode String
    Kubernetes mode of the cluster. - Can be: K3S, MANAGED. - Default: MANAGED.
    maxRunningNodes Number
    Maximum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters] - Must be: >= 1.

    • Default: 10.
    minRunningNodes Number
    Minimum number of nodes running for the cluster. [NOTE: have to be set to 1 in case of K3S clusters]. - Must be: >= 1.

    • Default: 3.
    name String
    Name of the cluster.
    organizationId String
    Id of the organization.
    region String
    Region of the cluster.
    routingTables List<Property Map>
    List of routes of the cluster.
    state String
    State of the cluster. - Can be: DEPLOYED, STOPPED. - Default: DEPLOYED.

    Supporting Types

    ClusterFeatures, ClusterFeaturesArgs

    ExistingVpc ediri.Qovery.Inputs.ClusterFeaturesExistingVpc
    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 ClusterFeaturesExistingVpc
    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 ClusterFeaturesExistingVpc
    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 ClusterFeaturesExistingVpc
    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.
    existing_vpc ClusterFeaturesExistingVpc
    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.
    existingVpc Property Map
    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.

    ClusterFeaturesExistingVpc, ClusterFeaturesExistingVpcArgs

    AwsVpcEksId string
    Aws VPC id
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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

    ClusterRoutingTable, ClusterRoutingTableArgs

    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.

    Import

     $ pulumi import qovery:index/cluster:Cluster my_cluster "<organization_id>,<cluster_id>"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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