GroupCluster

This resource allows you to create and manage group clusters for your GitLab groups. For further information on clusters, consult the gitlab documentation.

Create a GroupCluster Resource

new GroupCluster(name: string, args: GroupClusterArgs, opts?: CustomResourceOptions);

def GroupCluster(resource_name, opts=None, domain=None, enabled=None, environment_scope=None, group=None, kubernetes_api_url=None, kubernetes_authorization_type=None, kubernetes_ca_cert=None, kubernetes_token=None, managed=None, management_project_id=None, name=None, __props__=None);

func NewGroupCluster(ctx *Context, name string, args GroupClusterArgs, opts ...ResourceOption) (*GroupCluster, error)

public GroupCluster(string name, GroupClusterArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GroupClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GroupClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

GroupCluster Resource Properties

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

Inputs

The GroupCluster resource accepts the following input properties:

Group string: The id of the group to add the cluster to.
KubernetesApiUrl string: The URL to access the Kubernetes API.
KubernetesToken string: The token to authenticate against Kubernetes.
Domain string: The base domain of the cluster.
Enabled bool: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
EnvironmentScope string: The associated environment to the cluster. Defaults to *.
KubernetesAuthorizationType string: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
KubernetesCaCert string: TLS certificate (needed if API is using a self-signed TLS certificate).
Managed bool: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
ManagementProjectId string
Name string: The name of cluster.

Group string: The id of the group to add the cluster to.
KubernetesApiUrl string: The URL to access the Kubernetes API.
KubernetesToken string: The token to authenticate against Kubernetes.
Domain string: The base domain of the cluster.
Enabled bool: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
EnvironmentScope string: The associated environment to the cluster. Defaults to *.
KubernetesAuthorizationType string: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
KubernetesCaCert string: TLS certificate (needed if API is using a self-signed TLS certificate).
Managed bool: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
ManagementProjectId string
Name string: The name of cluster.

group string: The id of the group to add the cluster to.
kubernetesApiUrl string: The URL to access the Kubernetes API.
kubernetesToken string: The token to authenticate against Kubernetes.
domain string: The base domain of the cluster.
enabled boolean: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environmentScope string: The associated environment to the cluster. Defaults to *.
kubernetesAuthorizationType string: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetesCaCert string: TLS certificate (needed if API is using a self-signed TLS certificate).
managed boolean: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
managementProjectId string
name string: The name of cluster.

group str: The id of the group to add the cluster to.
kubernetes_api_url str: The URL to access the Kubernetes API.
kubernetes_token str: The token to authenticate against Kubernetes.
domain str: The base domain of the cluster.
enabled bool: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environment_scope str: The associated environment to the cluster. Defaults to *.
kubernetes_authorization_type str: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetes_ca_cert str: TLS certificate (needed if API is using a self-signed TLS certificate).
managed bool: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
management_project_id str
name str: The name of cluster.

Outputs

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

ClusterType string
CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
PlatformType string
ProviderType string

ClusterType string
CreatedAt string
Id string: The provider-assigned unique ID for this managed resource.
PlatformType string
ProviderType string

clusterType string
createdAt string
id string: The provider-assigned unique ID for this managed resource.
platformType string
providerType string

cluster_type str
created_at str
id str: The provider-assigned unique ID for this managed resource.
platform_type str
provider_type str

Look up an Existing GroupCluster Resource

Get an existing GroupCluster 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?: GroupClusterState, opts?: CustomResourceOptions): GroupCluster

static get(resource_name, id, opts=None, cluster_type=None, created_at=None, domain=None, enabled=None, environment_scope=None, group=None, kubernetes_api_url=None, kubernetes_authorization_type=None, kubernetes_ca_cert=None, kubernetes_token=None, managed=None, management_project_id=None, name=None, platform_type=None, provider_type=None, __props__=None);

func GetGroupCluster(ctx *Context, name string, id IDInput, state *GroupClusterState, opts ...ResourceOption) (*GroupCluster, error)

public static GroupCluster Get(string name, Input<string> id, GroupClusterState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

ClusterType string
CreatedAt string
Domain string: The base domain of the cluster.
Enabled bool: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
EnvironmentScope string: The associated environment to the cluster. Defaults to *.
Group string: The id of the group to add the cluster to.
KubernetesApiUrl string: The URL to access the Kubernetes API.
KubernetesAuthorizationType string: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
KubernetesCaCert string: TLS certificate (needed if API is using a self-signed TLS certificate).
KubernetesToken string: The token to authenticate against Kubernetes.
Managed bool: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
ManagementProjectId string
Name string: The name of cluster.
PlatformType string
ProviderType string

ClusterType string
CreatedAt string
Domain string: The base domain of the cluster.
Enabled bool: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
EnvironmentScope string: The associated environment to the cluster. Defaults to *.
Group string: The id of the group to add the cluster to.
KubernetesApiUrl string: The URL to access the Kubernetes API.
KubernetesAuthorizationType string: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
KubernetesCaCert string: TLS certificate (needed if API is using a self-signed TLS certificate).
KubernetesToken string: The token to authenticate against Kubernetes.
Managed bool: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
ManagementProjectId string
Name string: The name of cluster.
PlatformType string
ProviderType string

clusterType string
createdAt string
domain string: The base domain of the cluster.
enabled boolean: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environmentScope string: The associated environment to the cluster. Defaults to *.
group string: The id of the group to add the cluster to.
kubernetesApiUrl string: The URL to access the Kubernetes API.
kubernetesAuthorizationType string: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetesCaCert string: TLS certificate (needed if API is using a self-signed TLS certificate).
kubernetesToken string: The token to authenticate against Kubernetes.
managed boolean: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
managementProjectId string
name string: The name of cluster.
platformType string
providerType string

cluster_type str
created_at str
domain str: The base domain of the cluster.
enabled bool: Determines if cluster is active or not. Defaults to true. This attribute cannot be read.
environment_scope str: The associated environment to the cluster. Defaults to *.
group str: The id of the group to add the cluster to.
kubernetes_api_url str: The URL to access the Kubernetes API.
kubernetes_authorization_type str: The cluster authorization type. Valid values are rbac, abac, unknown_authorization. Defaults to rbac.
kubernetes_ca_cert str: TLS certificate (needed if API is using a self-signed TLS certificate).
kubernetes_token str: The token to authenticate against Kubernetes.
managed bool: Determines if cluster is managed by gitlab or not. Defaults to true. This attribute cannot be read.
management_project_id str
name str: The name of cluster.
platform_type str
provider_type str

Package Details

Repository: https://github.com/pulumi/pulumi-gitlab
License: Apache-2.0
Notes: This Pulumi package is based on the gitlab Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud