com.pulumi.gitlab.kotlin.ClusterAgentTokenArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gitlab-kotlin Show documentation
Show all versions of pulumi-gitlab-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gitlab.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gitlab.ClusterAgentTokenArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* The `gitlab.ClusterAgentToken` resource allows to manage the lifecycle of a token for a GitLab Agent for Kubernetes.
* > Requires at least maintainer permissions on the project.
* > Requires at least GitLab 15.0
* **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html#create-an-agent-token)
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gitlab from "@pulumi/gitlab";
* import * as helm from "@pulumi/helm";
* // Create token for an agent
* const example = new gitlab.ClusterAgentToken("example", {
* project: "12345",
* agentId: 42,
* name: "some-token",
* description: "some token",
* });
* // The following example creates a GitLab Agent for Kubernetes in a given project,
* // creates a token and install the `gitlab-agent` Helm Chart.
* // (see https://gitlab.com/gitlab-org/charts/gitlab-agent)
* const this = gitlab.getProject({
* pathWithNamespace: "my-org/example",
* });
* const thisClusterAgent = new gitlab.ClusterAgent("this", {
* project: _this.then(_this => _this.id),
* name: "my-agent",
* });
* const thisClusterAgentToken = new gitlab.ClusterAgentToken("this", {
* project: _this.then(_this => _this.id),
* agentId: thisClusterAgent.agentId,
* name: "my-agent-token",
* description: "Token for the my-agent used with `gitlab-agent` Helm Chart",
* });
* const gitlabAgent = new helm.index.Release("gitlab_agent", {
* name: "gitlab-agent",
* namespace: "gitlab-agent",
* createNamespace: true,
* repository: "https://charts.gitlab.io",
* chart: "gitlab-agent",
* version: "1.2.0",
* set: [{
* name: "config.token",
* value: thisClusterAgentToken.token,
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_gitlab as gitlab
* import pulumi_helm as helm
* # Create token for an agent
* example = gitlab.ClusterAgentToken("example",
* project="12345",
* agent_id=42,
* name="some-token",
* description="some token")
* # The following example creates a GitLab Agent for Kubernetes in a given project,
* # creates a token and install the `gitlab-agent` Helm Chart.
* # (see https://gitlab.com/gitlab-org/charts/gitlab-agent)
* this = gitlab.get_project(path_with_namespace="my-org/example")
* this_cluster_agent = gitlab.ClusterAgent("this",
* project=this.id,
* name="my-agent")
* this_cluster_agent_token = gitlab.ClusterAgentToken("this",
* project=this.id,
* agent_id=this_cluster_agent.agent_id,
* name="my-agent-token",
* description="Token for the my-agent used with `gitlab-agent` Helm Chart")
* gitlab_agent = helm.index.Release("gitlab_agent",
* name=gitlab-agent,
* namespace=gitlab-agent,
* create_namespace=True,
* repository=https://charts.gitlab.io,
* chart=gitlab-agent,
* version=1.2.0,
* set=[{
* name: config.token,
* value: this_cluster_agent_token.token,
* }])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using GitLab = Pulumi.GitLab;
* using Helm = Pulumi.Helm;
* return await Deployment.RunAsync(() =>
* {
* // Create token for an agent
* var example = new GitLab.ClusterAgentToken("example", new()
* {
* Project = "12345",
* AgentId = 42,
* Name = "some-token",
* Description = "some token",
* });
* // The following example creates a GitLab Agent for Kubernetes in a given project,
* // creates a token and install the `gitlab-agent` Helm Chart.
* // (see https://gitlab.com/gitlab-org/charts/gitlab-agent)
* var @this = GitLab.GetProject.Invoke(new()
* {
* PathWithNamespace = "my-org/example",
* });
* var thisClusterAgent = new GitLab.ClusterAgent("this", new()
* {
* Project = @this.Apply(@this => @this.Apply(getProjectResult => getProjectResult.Id)),
* Name = "my-agent",
* });
* var thisClusterAgentToken = new GitLab.ClusterAgentToken("this", new()
* {
* Project = @this.Apply(@this => @this.Apply(getProjectResult => getProjectResult.Id)),
* AgentId = thisClusterAgent.AgentId,
* Name = "my-agent-token",
* Description = "Token for the my-agent used with `gitlab-agent` Helm Chart",
* });
* var gitlabAgent = new Helm.Index.Release("gitlab_agent", new()
* {
* Name = "gitlab-agent",
* Namespace = "gitlab-agent",
* CreateNamespace = true,
* Repository = "https://charts.gitlab.io",
* Chart = "gitlab-agent",
* Version = "1.2.0",
* Set = new[]
* {
* {
* { "name", "config.token" },
* { "value", thisClusterAgentToken.Token },
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
* "github.com/pulumi/pulumi-helm/sdk/v1/go/helm"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* // Create token for an agent
* _, err := gitlab.NewClusterAgentToken(ctx, "example", &gitlab.ClusterAgentTokenArgs{
* Project: pulumi.String("12345"),
* AgentId: pulumi.Int(42),
* Name: pulumi.String("some-token"),
* Description: pulumi.String("some token"),
* })
* if err != nil {
* return err
* }
* // The following example creates a GitLab Agent for Kubernetes in a given project,
* // creates a token and install the `gitlab-agent` Helm Chart.
* // (see https://gitlab.com/gitlab-org/charts/gitlab-agent)
* this, err := gitlab.LookupProject(ctx, &gitlab.LookupProjectArgs{
* PathWithNamespace: pulumi.StringRef("my-org/example"),
* }, nil)
* if err != nil {
* return err
* }
* thisClusterAgent, err := gitlab.NewClusterAgent(ctx, "this", &gitlab.ClusterAgentArgs{
* Project: pulumi.String(this.Id),
* Name: pulumi.String("my-agent"),
* })
* if err != nil {
* return err
* }
* thisClusterAgentToken, err := gitlab.NewClusterAgentToken(ctx, "this", &gitlab.ClusterAgentTokenArgs{
* Project: pulumi.String(this.Id),
* AgentId: thisClusterAgent.AgentId,
* Name: pulumi.String("my-agent-token"),
* Description: pulumi.String("Token for the my-agent used with `gitlab-agent` Helm Chart"),
* })
* if err != nil {
* return err
* }
* _, err = index.NewRelease(ctx, "gitlab_agent", &index.ReleaseArgs{
* Name: "gitlab-agent",
* Namespace: "gitlab-agent",
* CreateNamespace: true,
* Repository: "https://charts.gitlab.io",
* Chart: "gitlab-agent",
* Version: "1.2.0",
* Set: []map[string]interface{}{
* map[string]interface{}{
* "name": "config.token",
* "value": thisClusterAgentToken.Token,
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.gitlab.ClusterAgentToken;
* import com.pulumi.gitlab.ClusterAgentTokenArgs;
* import com.pulumi.gitlab.GitlabFunctions;
* import com.pulumi.gitlab.inputs.GetProjectArgs;
* import com.pulumi.gitlab.ClusterAgent;
* import com.pulumi.gitlab.ClusterAgentArgs;
* import com.pulumi.helm.release;
* import com.pulumi.helm.ReleaseArgs;
* 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) {
* // Create token for an agent
* var example = new ClusterAgentToken("example", ClusterAgentTokenArgs.builder()
* .project("12345")
* .agentId(42)
* .name("some-token")
* .description("some token")
* .build());
* // The following example creates a GitLab Agent for Kubernetes in a given project,
* // creates a token and install the `gitlab-agent` Helm Chart.
* // (see https://gitlab.com/gitlab-org/charts/gitlab-agent)
* final var this = GitlabFunctions.getProject(GetProjectArgs.builder()
* .pathWithNamespace("my-org/example")
* .build());
* var thisClusterAgent = new ClusterAgent("thisClusterAgent", ClusterAgentArgs.builder()
* .project(this_.id())
* .name("my-agent")
* .build());
* var thisClusterAgentToken = new ClusterAgentToken("thisClusterAgentToken", ClusterAgentTokenArgs.builder()
* .project(this_.id())
* .agentId(thisClusterAgent.agentId())
* .name("my-agent-token")
* .description("Token for the my-agent used with `gitlab-agent` Helm Chart")
* .build());
* var gitlabAgent = new Release("gitlabAgent", ReleaseArgs.builder()
* .name("gitlab-agent")
* .namespace("gitlab-agent")
* .createNamespace(true)
* .repository("https://charts.gitlab.io")
* .chart("gitlab-agent")
* .version("1.2.0")
* .set(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* # Create token for an agent
* example:
* type: gitlab:ClusterAgentToken
* properties:
* project: '12345'
* agentId: 42
* name: some-token
* description: some token
* thisClusterAgent:
* type: gitlab:ClusterAgent
* name: this
* properties:
* project: ${this.id}
* name: my-agent
* thisClusterAgentToken:
* type: gitlab:ClusterAgentToken
* name: this
* properties:
* project: ${this.id}
* agentId: ${thisClusterAgent.agentId}
* name: my-agent-token
* description: Token for the my-agent used with `gitlab-agent` Helm Chart
* gitlabAgent:
* type: helm:release
* name: gitlab_agent
* properties:
* name: gitlab-agent
* namespace: gitlab-agent
* createNamespace: true
* repository: https://charts.gitlab.io
* chart: gitlab-agent
* version: 1.2.0
* set:
* - name: config.token
* value: ${thisClusterAgentToken.token}
* variables:
* # The following example creates a GitLab Agent for Kubernetes in a given project,
* # // creates a token and install the `gitlab-agent` Helm Chart.
* # // (see https://gitlab.com/gitlab-org/charts/gitlab-agent)
* this:
* fn::invoke:
* Function: gitlab:getProject
* Arguments:
* pathWithNamespace: my-org/example
* ```
*
* ## Import
* A token for a GitLab Agent for Kubernetes can be imported with the following command and the id pattern `::`:
* ```sh
* $ pulumi import gitlab:index/clusterAgentToken:ClusterAgentToken example '12345:42:1'
* ```
* ATTENTION: the `token` resource attribute is not available for imported resources as this information cannot be read from the GitLab API.
* @property agentId The ID of the agent.
* @property description The Description for the agent.
* @property name The Name of the agent.
* @property project ID or full path of the project maintained by the authenticated user.
*/
public data class ClusterAgentTokenArgs(
public val agentId: Output? = null,
public val description: Output? = null,
public val name: Output? = null,
public val project: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gitlab.ClusterAgentTokenArgs =
com.pulumi.gitlab.ClusterAgentTokenArgs.builder()
.agentId(agentId?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ClusterAgentTokenArgs].
*/
@PulumiTagMarker
public class ClusterAgentTokenArgsBuilder internal constructor() {
private var agentId: Output? = null
private var description: Output? = null
private var name: Output? = null
private var project: Output? = null
/**
* @param value The ID of the agent.
*/
@JvmName("ciqlqslxumgcsicf")
public suspend fun agentId(`value`: Output) {
this.agentId = value
}
/**
* @param value The Description for the agent.
*/
@JvmName("eldtdpfworblepvt")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The Name of the agent.
*/
@JvmName("ehnpnrnaytueuchk")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value ID or full path of the project maintained by the authenticated user.
*/
@JvmName("fysvloxpknvjcyys")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The ID of the agent.
*/
@JvmName("rhksddphgjyypvef")
public suspend fun agentId(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.agentId = mapped
}
/**
* @param value The Description for the agent.
*/
@JvmName("oxpsxnmgckbwvggc")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The Name of the agent.
*/
@JvmName("hmlxddikwoymonau")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value ID or full path of the project maintained by the authenticated user.
*/
@JvmName("lbhvejruqcwvtwlp")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
internal fun build(): ClusterAgentTokenArgs = ClusterAgentTokenArgs(
agentId = agentId,
description = description,
name = name,
project = project,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy