GitHub

Pulumi Official
Package maintained by Pulumi
v4.15.1 published on Wednesday, Aug 10, 2022 by Pulumi

ActionsRunnerGroup

This resource allows you to create and manage GitHub Actions runner groups within your GitHub enterprise organizations. You must have admin access to an organization to use this resource.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var exampleRepository = new Github.Repository("exampleRepository");

    var exampleActionsRunnerGroup = new Github.ActionsRunnerGroup("exampleActionsRunnerGroup", new()
    {
        Visibility = "selected",
        SelectedRepositoryIds = new[]
        {
            exampleRepository.RepoId,
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleRepository, err := github.NewRepository(ctx, "exampleRepository", nil)
		if err != nil {
			return err
		}
		_, err = github.NewActionsRunnerGroup(ctx, "exampleActionsRunnerGroup", &github.ActionsRunnerGroupArgs{
			Visibility: pulumi.String("selected"),
			SelectedRepositoryIds: pulumi.IntArray{
				exampleRepository.RepoId,
			},
		})
		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.github.Repository;
import com.pulumi.github.ActionsRunnerGroup;
import com.pulumi.github.ActionsRunnerGroupArgs;
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 exampleRepository = new Repository("exampleRepository");

        var exampleActionsRunnerGroup = new ActionsRunnerGroup("exampleActionsRunnerGroup", ActionsRunnerGroupArgs.builder()        
            .visibility("selected")
            .selectedRepositoryIds(exampleRepository.repoId())
            .build());

    }
}
import pulumi
import pulumi_github as github

example_repository = github.Repository("exampleRepository")
example_actions_runner_group = github.ActionsRunnerGroup("exampleActionsRunnerGroup",
    visibility="selected",
    selected_repository_ids=[example_repository.repo_id])
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const exampleRepository = new github.Repository("exampleRepository", {});
const exampleActionsRunnerGroup = new github.ActionsRunnerGroup("exampleActionsRunnerGroup", {
    visibility: "selected",
    selectedRepositoryIds: [exampleRepository.repoId],
});
resources:
  exampleRepository:
    type: github:Repository
  exampleActionsRunnerGroup:
    type: github:ActionsRunnerGroup
    properties:
      visibility: selected
      selectedRepositoryIds:
        - ${exampleRepository.repoId}

Create a ActionsRunnerGroup Resource

new ActionsRunnerGroup(name: string, args: ActionsRunnerGroupArgs, opts?: CustomResourceOptions);
@overload
def ActionsRunnerGroup(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       name: Optional[str] = None,
                       selected_repository_ids: Optional[Sequence[int]] = None,
                       visibility: Optional[str] = None)
@overload
def ActionsRunnerGroup(resource_name: str,
                       args: ActionsRunnerGroupArgs,
                       opts: Optional[ResourceOptions] = None)
func NewActionsRunnerGroup(ctx *Context, name string, args ActionsRunnerGroupArgs, opts ...ResourceOption) (*ActionsRunnerGroup, error)
public ActionsRunnerGroup(string name, ActionsRunnerGroupArgs args, CustomResourceOptions? opts = null)
public ActionsRunnerGroup(String name, ActionsRunnerGroupArgs args)
public ActionsRunnerGroup(String name, ActionsRunnerGroupArgs args, CustomResourceOptions options)
type: github:ActionsRunnerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ActionsRunnerGroupArgs
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 ActionsRunnerGroupArgs
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 ActionsRunnerGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ActionsRunnerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ActionsRunnerGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ActionsRunnerGroup 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 ActionsRunnerGroup resource accepts the following input properties:

Visibility string

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

Name string

Name of the runner group

SelectedRepositoryIds List<int>

IDs of the repositories which should be added to the runner group

Visibility string

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

Name string

Name of the runner group

SelectedRepositoryIds []int

IDs of the repositories which should be added to the runner group

visibility String

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

name String

Name of the runner group

selectedRepositoryIds List<Integer>

IDs of the repositories which should be added to the runner group

visibility string

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

name string

Name of the runner group

selectedRepositoryIds number[]

IDs of the repositories which should be added to the runner group

visibility str

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

name str

Name of the runner group

selected_repository_ids Sequence[int]

IDs of the repositories which should be added to the runner group

visibility String

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

name String

Name of the runner group

selectedRepositoryIds List<Number>

IDs of the repositories which should be added to the runner group

Outputs

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

AllowsPublicRepositories bool

Whether public repositories can be added to the runner group

Default bool

Whether this is the default runner group

Etag string

An etag representing the runner group object

Id string

The provider-assigned unique ID for this managed resource.

Inherited bool

Whether the runner group is inherited from the enterprise level

RunnersUrl string

The GitHub API URL for the runner group's runners

SelectedRepositoriesUrl string

Github API URL for the runner group's repositories

AllowsPublicRepositories bool

Whether public repositories can be added to the runner group

Default bool

Whether this is the default runner group

Etag string

An etag representing the runner group object

Id string

The provider-assigned unique ID for this managed resource.

Inherited bool

Whether the runner group is inherited from the enterprise level

RunnersUrl string

The GitHub API URL for the runner group's runners

SelectedRepositoriesUrl string

Github API URL for the runner group's repositories

allowsPublicRepositories Boolean

Whether public repositories can be added to the runner group

default_ Boolean

Whether this is the default runner group

etag String

An etag representing the runner group object

id String

The provider-assigned unique ID for this managed resource.

inherited Boolean

Whether the runner group is inherited from the enterprise level

runnersUrl String

The GitHub API URL for the runner group's runners

selectedRepositoriesUrl String

Github API URL for the runner group's repositories

allowsPublicRepositories boolean

Whether public repositories can be added to the runner group

default boolean

Whether this is the default runner group

etag string

An etag representing the runner group object

id string

The provider-assigned unique ID for this managed resource.

inherited boolean

Whether the runner group is inherited from the enterprise level

runnersUrl string

The GitHub API URL for the runner group's runners

selectedRepositoriesUrl string

Github API URL for the runner group's repositories

allows_public_repositories bool

Whether public repositories can be added to the runner group

default bool

Whether this is the default runner group

etag str

An etag representing the runner group object

id str

The provider-assigned unique ID for this managed resource.

inherited bool

Whether the runner group is inherited from the enterprise level

runners_url str

The GitHub API URL for the runner group's runners

selected_repositories_url str

Github API URL for the runner group's repositories

allowsPublicRepositories Boolean

Whether public repositories can be added to the runner group

default Boolean

Whether this is the default runner group

etag String

An etag representing the runner group object

id String

The provider-assigned unique ID for this managed resource.

inherited Boolean

Whether the runner group is inherited from the enterprise level

runnersUrl String

The GitHub API URL for the runner group's runners

selectedRepositoriesUrl String

Github API URL for the runner group's repositories

Look up an Existing ActionsRunnerGroup Resource

Get an existing ActionsRunnerGroup 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?: ActionsRunnerGroupState, opts?: CustomResourceOptions): ActionsRunnerGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allows_public_repositories: Optional[bool] = None,
        default: Optional[bool] = None,
        etag: Optional[str] = None,
        inherited: Optional[bool] = None,
        name: Optional[str] = None,
        runners_url: Optional[str] = None,
        selected_repositories_url: Optional[str] = None,
        selected_repository_ids: Optional[Sequence[int]] = None,
        visibility: Optional[str] = None) -> ActionsRunnerGroup
func GetActionsRunnerGroup(ctx *Context, name string, id IDInput, state *ActionsRunnerGroupState, opts ...ResourceOption) (*ActionsRunnerGroup, error)
public static ActionsRunnerGroup Get(string name, Input<string> id, ActionsRunnerGroupState? state, CustomResourceOptions? opts = null)
public static ActionsRunnerGroup get(String name, Output<String> id, ActionsRunnerGroupState 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:
AllowsPublicRepositories bool

Whether public repositories can be added to the runner group

Default bool

Whether this is the default runner group

Etag string

An etag representing the runner group object

Inherited bool

Whether the runner group is inherited from the enterprise level

Name string

Name of the runner group

RunnersUrl string

The GitHub API URL for the runner group's runners

SelectedRepositoriesUrl string

Github API URL for the runner group's repositories

SelectedRepositoryIds List<int>

IDs of the repositories which should be added to the runner group

Visibility string

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

AllowsPublicRepositories bool

Whether public repositories can be added to the runner group

Default bool

Whether this is the default runner group

Etag string

An etag representing the runner group object

Inherited bool

Whether the runner group is inherited from the enterprise level

Name string

Name of the runner group

RunnersUrl string

The GitHub API URL for the runner group's runners

SelectedRepositoriesUrl string

Github API URL for the runner group's repositories

SelectedRepositoryIds []int

IDs of the repositories which should be added to the runner group

Visibility string

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

allowsPublicRepositories Boolean

Whether public repositories can be added to the runner group

default_ Boolean

Whether this is the default runner group

etag String

An etag representing the runner group object

inherited Boolean

Whether the runner group is inherited from the enterprise level

name String

Name of the runner group

runnersUrl String

The GitHub API URL for the runner group's runners

selectedRepositoriesUrl String

Github API URL for the runner group's repositories

selectedRepositoryIds List<Integer>

IDs of the repositories which should be added to the runner group

visibility String

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

allowsPublicRepositories boolean

Whether public repositories can be added to the runner group

default boolean

Whether this is the default runner group

etag string

An etag representing the runner group object

inherited boolean

Whether the runner group is inherited from the enterprise level

name string

Name of the runner group

runnersUrl string

The GitHub API URL for the runner group's runners

selectedRepositoriesUrl string

Github API URL for the runner group's repositories

selectedRepositoryIds number[]

IDs of the repositories which should be added to the runner group

visibility string

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

allows_public_repositories bool

Whether public repositories can be added to the runner group

default bool

Whether this is the default runner group

etag str

An etag representing the runner group object

inherited bool

Whether the runner group is inherited from the enterprise level

name str

Name of the runner group

runners_url str

The GitHub API URL for the runner group's runners

selected_repositories_url str

Github API URL for the runner group's repositories

selected_repository_ids Sequence[int]

IDs of the repositories which should be added to the runner group

visibility str

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

allowsPublicRepositories Boolean

Whether public repositories can be added to the runner group

default Boolean

Whether this is the default runner group

etag String

An etag representing the runner group object

inherited Boolean

Whether the runner group is inherited from the enterprise level

name String

Name of the runner group

runnersUrl String

The GitHub API URL for the runner group's runners

selectedRepositoriesUrl String

Github API URL for the runner group's repositories

selectedRepositoryIds List<Number>

IDs of the repositories which should be added to the runner group

visibility String

Visibility of a runner group. Whether the runner group can include all, selected, or private repositories. A value of private is not currently supported due to limitations in the GitHub API.

Import

This resource can be imported using the ID of the runner group

 $ pulumi import github:index/actionsRunnerGroup:ActionsRunnerGroup test 7

Package Details

Repository
https://github.com/pulumi/pulumi-github
License
Apache-2.0
Notes

This Pulumi package is based on the github Terraform Provider.