gitlab logo
GitLab v4.9.0, Oct 24 22

gitlab.getClusterAgent

The gitlab.ClusterAgent data source allows to retrieve details about a GitLab Agent for Kubernetes.

Requires at least GitLab 14.10

Upstream API: GitLab REST API docs

Example Usage

using System.Collections.Generic;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    var example = GitLab.GetClusterAgent.Invoke(new()
    {
        AgentId = 1,
        Project = "12345",
    });

});
package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v4/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = gitlab.LookupClusterAgent(ctx, &GetClusterAgentArgs{
			AgentId: 1,
			Project: "12345",
		}, 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.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetClusterAgentArgs;
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 example = GitlabFunctions.getClusterAgent(GetClusterAgentArgs.builder()
            .agentId(1)
            .project("12345")
            .build());

    }
}
import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_cluster_agent(agent_id=1,
    project="12345")
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = pulumi.output(gitlab.getClusterAgent({
    agentId: 1,
    project: "12345",
}));
variables:
  example:
    fn::invoke:
      Function: gitlab:getClusterAgent
      Arguments:
        agentId: 1
        project: '12345'

Using getClusterAgent

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 getClusterAgent(args: GetClusterAgentArgs, opts?: InvokeOptions): Promise<GetClusterAgentResult>
function getClusterAgentOutput(args: GetClusterAgentOutputArgs, opts?: InvokeOptions): Output<GetClusterAgentResult>
def get_cluster_agent(agent_id: Optional[int] = None,
                      project: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetClusterAgentResult
def get_cluster_agent_output(agent_id: Optional[pulumi.Input[int]] = None,
                      project: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetClusterAgentResult]
func LookupClusterAgent(ctx *Context, args *LookupClusterAgentArgs, opts ...InvokeOption) (*LookupClusterAgentResult, error)
func LookupClusterAgentOutput(ctx *Context, args *LookupClusterAgentOutputArgs, opts ...InvokeOption) LookupClusterAgentResultOutput

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

public static class GetClusterAgent 
{
    public static Task<GetClusterAgentResult> InvokeAsync(GetClusterAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterAgentResult> Invoke(GetClusterAgentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterAgentResult> getClusterAgent(GetClusterAgentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: gitlab:index/getClusterAgent:getClusterAgent
  arguments:
    # arguments dictionary

The following arguments are supported:

AgentId int

The ID of the agent.

Project string

ID or full path of the project maintained by the authenticated user.

AgentId int

The ID of the agent.

Project string

ID or full path of the project maintained by the authenticated user.

agentId Integer

The ID of the agent.

project String

ID or full path of the project maintained by the authenticated user.

agentId number

The ID of the agent.

project string

ID or full path of the project maintained by the authenticated user.

agent_id int

The ID of the agent.

project str

ID or full path of the project maintained by the authenticated user.

agentId Number

The ID of the agent.

project String

ID or full path of the project maintained by the authenticated user.

getClusterAgent Result

The following output properties are available:

AgentId int

The ID of the agent.

CreatedAt string

The ISO8601 datetime when the agent was created.

CreatedByUserId int

The ID of the user who created the agent.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The Name of the agent.

Project string

ID or full path of the project maintained by the authenticated user.

AgentId int

The ID of the agent.

CreatedAt string

The ISO8601 datetime when the agent was created.

CreatedByUserId int

The ID of the user who created the agent.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The Name of the agent.

Project string

ID or full path of the project maintained by the authenticated user.

agentId Integer

The ID of the agent.

createdAt String

The ISO8601 datetime when the agent was created.

createdByUserId Integer

The ID of the user who created the agent.

id String

The provider-assigned unique ID for this managed resource.

name String

The Name of the agent.

project String

ID or full path of the project maintained by the authenticated user.

agentId number

The ID of the agent.

createdAt string

The ISO8601 datetime when the agent was created.

createdByUserId number

The ID of the user who created the agent.

id string

The provider-assigned unique ID for this managed resource.

name string

The Name of the agent.

project string

ID or full path of the project maintained by the authenticated user.

agent_id int

The ID of the agent.

created_at str

The ISO8601 datetime when the agent was created.

created_by_user_id int

The ID of the user who created the agent.

id str

The provider-assigned unique ID for this managed resource.

name str

The Name of the agent.

project str

ID or full path of the project maintained by the authenticated user.

agentId Number

The ID of the agent.

createdAt String

The ISO8601 datetime when the agent was created.

createdByUserId Number

The ID of the user who created the agent.

id String

The provider-assigned unique ID for this managed resource.

name String

The Name of the agent.

project String

ID or full path of the project maintained by the authenticated user.

Package Details

Repository
GitLab pulumi/pulumi-gitlab
License
Apache-2.0
Notes

This Pulumi package is based on the gitlab Terraform Provider.