pulumi-github-kotlin/com.pulumi.github.kotlin/ActionsOrganizationVariable

ActionsOrganizationVariable

class ActionsOrganizationVariable : KotlinCustomResource

This resource allows you to create and manage GitHub Actions variables within your GitHub organization. You must have write access to a repository to use this resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const exampleVariable = new github.ActionsOrganizationVariable("example_variable", {
    variableName: "example_variable_name",
    visibility: "private",
    value: "example_variable_value",
});
Content copied to clipboard
import pulumi
import pulumi_github as github
example_variable = github.ActionsOrganizationVariable("example_variable",
    variable_name="example_variable_name",
    visibility="private",
    value="example_variable_value")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
    var exampleVariable = new Github.ActionsOrganizationVariable("example_variable", new()
    {
        VariableName = "example_variable_name",
        Visibility = "private",
        Value = "example_variable_value",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := github.NewActionsOrganizationVariable(ctx, "example_variable", &github.ActionsOrganizationVariableArgs{
			VariableName: pulumi.String("example_variable_name"),
			Visibility:   pulumi.String("private"),
			Value:        pulumi.String("example_variable_value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.ActionsOrganizationVariable;
import com.pulumi.github.ActionsOrganizationVariableArgs;
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 exampleVariable = new ActionsOrganizationVariable("exampleVariable", ActionsOrganizationVariableArgs.builder()
            .variableName("example_variable_name")
            .visibility("private")
            .value("example_variable_value")
            .build());
    }
}
Content copied to clipboard
resources:
  exampleVariable:
    type: github:ActionsOrganizationVariable
    name: example_variable
    properties:
      variableName: example_variable_name
      visibility: private
      value: example_variable_value
Content copied to clipboard
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const repo = github.getRepository({
    fullName: "my-org/repo",
});
const exampleVariable = new github.ActionsOrganizationVariable("example_variable", {
    variableName: "example_variable_name",
    visibility: "selected",
    value: "example_variable_value",
    selectedRepositoryIds: [repo.then(repo => repo.repoId)],
});
Content copied to clipboard
import pulumi
import pulumi_github as github
repo = github.get_repository(full_name="my-org/repo")
example_variable = github.ActionsOrganizationVariable("example_variable",
    variable_name="example_variable_name",
    visibility="selected",
    value="example_variable_value",
    selected_repository_ids=[repo.repo_id])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
    var repo = Github.GetRepository.Invoke(new()
    {
        FullName = "my-org/repo",
    });
    var exampleVariable = new Github.ActionsOrganizationVariable("example_variable", new()
    {
        VariableName = "example_variable_name",
        Visibility = "selected",
        Value = "example_variable_value",
        SelectedRepositoryIds = new[]
        {
            repo.Apply(getRepositoryResult => getRepositoryResult.RepoId),
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		repo, err := github.LookupRepository(ctx, &github.LookupRepositoryArgs{
			FullName: pulumi.StringRef("my-org/repo"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = github.NewActionsOrganizationVariable(ctx, "example_variable", &github.ActionsOrganizationVariableArgs{
			VariableName: pulumi.String("example_variable_name"),
			Visibility:   pulumi.String("selected"),
			Value:        pulumi.String("example_variable_value"),
			SelectedRepositoryIds: pulumi.IntArray{
				pulumi.Int(repo.RepoId),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
import com.pulumi.github.inputs.GetRepositoryArgs;
import com.pulumi.github.ActionsOrganizationVariable;
import com.pulumi.github.ActionsOrganizationVariableArgs;
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 repo = GithubFunctions.getRepository(GetRepositoryArgs.builder()
            .fullName("my-org/repo")
            .build());
        var exampleVariable = new ActionsOrganizationVariable("exampleVariable", ActionsOrganizationVariableArgs.builder()
            .variableName("example_variable_name")
            .visibility("selected")
            .value("example_variable_value")
            .selectedRepositoryIds(repo.applyValue(getRepositoryResult -> getRepositoryResult.repoId()))
            .build());
    }
}
Content copied to clipboard
resources:
  exampleVariable:
    type: github:ActionsOrganizationVariable
    name: example_variable
    properties:
      variableName: example_variable_name
      visibility: selected
      value: example_variable_value
      selectedRepositoryIds:
        - ${repo.repoId}
variables:
  repo:
    fn::invoke:
      function: github:getRepository
      arguments:
        fullName: my-org/repo
Content copied to clipboard

Import

This resource can be imported using an ID made up of the variable name:

$ pulumi import github:index/actionsOrganizationVariable:ActionsOrganizationVariable test_variable test_variable_name
Content copied to clipboard

Properties

Link copied to clipboard
val createdAt: Output<String>

Date of actions_variable creation.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val selectedRepositoryIds: Output<List<Int>>?

An array of repository ids that can access the organization variable.

Link copied to clipboard
val updatedAt: Output<String>

Date of actions_variable update.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val value: Output<String>

Value of the variable

Link copied to clipboard
val variableName: Output<String>

Name of the variable

Link copied to clipboard
val visibility: Output<String>

Configures the access that repositories have to the organization variable. Must be one of all, private, selected. selected_repository_ids is required if set to selected.