1. Packages
  2. Github Provider
  3. API Docs
  4. EnterpriseActionsRunnerGroup
GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi

github.EnterpriseActionsRunnerGroup

Explore with Pulumi AI

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const enterprise = github.getEnterprise({
    slug: "my-enterprise",
});
const enterpriseOrganization = new github.EnterpriseOrganization("enterprise_organization", {
    enterpriseId: enterprise.then(enterprise => enterprise.id),
    name: "my-organization",
    billingEmail: "octocat@octo.cat",
    adminLogins: ["octocat"],
});
const example = new github.EnterpriseActionsRunnerGroup("example", {
    name: "my-awesome-runner-group",
    enterpriseSlug: enterprise.then(enterprise => enterprise.slug),
    allowsPublicRepositories: true,
    visibility: "selected",
    selectedOrganizationIds: [enterpriseOrganization.databaseId],
    restrictedToWorkflows: true,
    selectedWorkflows: ["my-organization/my-repo/.github/workflows/cool-workflow.yaml@refs/tags/v1"],
});
Copy
import pulumi
import pulumi_github as github

enterprise = github.get_enterprise(slug="my-enterprise")
enterprise_organization = github.EnterpriseOrganization("enterprise_organization",
    enterprise_id=enterprise.id,
    name="my-organization",
    billing_email="octocat@octo.cat",
    admin_logins=["octocat"])
example = github.EnterpriseActionsRunnerGroup("example",
    name="my-awesome-runner-group",
    enterprise_slug=enterprise.slug,
    allows_public_repositories=True,
    visibility="selected",
    selected_organization_ids=[enterprise_organization.database_id],
    restricted_to_workflows=True,
    selected_workflows=["my-organization/my-repo/.github/workflows/cool-workflow.yaml@refs/tags/v1"])
Copy
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 {
		enterprise, err := github.GetEnterprise(ctx, &github.GetEnterpriseArgs{
			Slug: "my-enterprise",
		}, nil)
		if err != nil {
			return err
		}
		enterpriseOrganization, err := github.NewEnterpriseOrganization(ctx, "enterprise_organization", &github.EnterpriseOrganizationArgs{
			EnterpriseId: pulumi.String(enterprise.Id),
			Name:         pulumi.String("my-organization"),
			BillingEmail: pulumi.String("octocat@octo.cat"),
			AdminLogins: pulumi.StringArray{
				pulumi.String("octocat"),
			},
		})
		if err != nil {
			return err
		}
		_, err = github.NewEnterpriseActionsRunnerGroup(ctx, "example", &github.EnterpriseActionsRunnerGroupArgs{
			Name:                     pulumi.String("my-awesome-runner-group"),
			EnterpriseSlug:           pulumi.String(enterprise.Slug),
			AllowsPublicRepositories: pulumi.Bool(true),
			Visibility:               pulumi.String("selected"),
			SelectedOrganizationIds: pulumi.IntArray{
				enterpriseOrganization.DatabaseId,
			},
			RestrictedToWorkflows: pulumi.Bool(true),
			SelectedWorkflows: pulumi.StringArray{
				pulumi.String("my-organization/my-repo/.github/workflows/cool-workflow.yaml@refs/tags/v1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;

return await Deployment.RunAsync(() => 
{
    var enterprise = Github.GetEnterprise.Invoke(new()
    {
        Slug = "my-enterprise",
    });

    var enterpriseOrganization = new Github.EnterpriseOrganization("enterprise_organization", new()
    {
        EnterpriseId = enterprise.Apply(getEnterpriseResult => getEnterpriseResult.Id),
        Name = "my-organization",
        BillingEmail = "octocat@octo.cat",
        AdminLogins = new[]
        {
            "octocat",
        },
    });

    var example = new Github.EnterpriseActionsRunnerGroup("example", new()
    {
        Name = "my-awesome-runner-group",
        EnterpriseSlug = enterprise.Apply(getEnterpriseResult => getEnterpriseResult.Slug),
        AllowsPublicRepositories = true,
        Visibility = "selected",
        SelectedOrganizationIds = new[]
        {
            enterpriseOrganization.DatabaseId,
        },
        RestrictedToWorkflows = true,
        SelectedWorkflows = new[]
        {
            "my-organization/my-repo/.github/workflows/cool-workflow.yaml@refs/tags/v1",
        },
    });

});
Copy
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.GetEnterpriseArgs;
import com.pulumi.github.EnterpriseOrganization;
import com.pulumi.github.EnterpriseOrganizationArgs;
import com.pulumi.github.EnterpriseActionsRunnerGroup;
import com.pulumi.github.EnterpriseActionsRunnerGroupArgs;
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 enterprise = GithubFunctions.getEnterprise(GetEnterpriseArgs.builder()
            .slug("my-enterprise")
            .build());

        var enterpriseOrganization = new EnterpriseOrganization("enterpriseOrganization", EnterpriseOrganizationArgs.builder()
            .enterpriseId(enterprise.applyValue(getEnterpriseResult -> getEnterpriseResult.id()))
            .name("my-organization")
            .billingEmail("octocat@octo.cat")
            .adminLogins("octocat")
            .build());

        var example = new EnterpriseActionsRunnerGroup("example", EnterpriseActionsRunnerGroupArgs.builder()
            .name("my-awesome-runner-group")
            .enterpriseSlug(enterprise.applyValue(getEnterpriseResult -> getEnterpriseResult.slug()))
            .allowsPublicRepositories(true)
            .visibility("selected")
            .selectedOrganizationIds(enterpriseOrganization.databaseId())
            .restrictedToWorkflows(true)
            .selectedWorkflows("my-organization/my-repo/.github/workflows/cool-workflow.yaml@refs/tags/v1")
            .build());

    }
}
Copy
resources:
  enterpriseOrganization:
    type: github:EnterpriseOrganization
    name: enterprise_organization
    properties:
      enterpriseId: ${enterprise.id}
      name: my-organization
      billingEmail: octocat@octo.cat
      adminLogins:
        - octocat
  example:
    type: github:EnterpriseActionsRunnerGroup
    properties:
      name: my-awesome-runner-group
      enterpriseSlug: ${enterprise.slug}
      allowsPublicRepositories: true
      visibility: selected
      selectedOrganizationIds:
        - ${enterpriseOrganization.databaseId}
      restrictedToWorkflows: true
      selectedWorkflows:
        - my-organization/my-repo/.github/workflows/cool-workflow.yaml@refs/tags/v1
variables:
  enterprise:
    fn::invoke:
      function: github:getEnterprise
      arguments:
        slug: my-enterprise
Copy

Create EnterpriseActionsRunnerGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EnterpriseActionsRunnerGroup(name: string, args: EnterpriseActionsRunnerGroupArgs, opts?: CustomResourceOptions);
@overload
def EnterpriseActionsRunnerGroup(resource_name: str,
                                 args: EnterpriseActionsRunnerGroupArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def EnterpriseActionsRunnerGroup(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 enterprise_slug: Optional[str] = None,
                                 visibility: Optional[str] = None,
                                 allows_public_repositories: Optional[bool] = None,
                                 name: Optional[str] = None,
                                 restricted_to_workflows: Optional[bool] = None,
                                 selected_organization_ids: Optional[Sequence[int]] = None,
                                 selected_workflows: Optional[Sequence[str]] = None)
func NewEnterpriseActionsRunnerGroup(ctx *Context, name string, args EnterpriseActionsRunnerGroupArgs, opts ...ResourceOption) (*EnterpriseActionsRunnerGroup, error)
public EnterpriseActionsRunnerGroup(string name, EnterpriseActionsRunnerGroupArgs args, CustomResourceOptions? opts = null)
public EnterpriseActionsRunnerGroup(String name, EnterpriseActionsRunnerGroupArgs args)
public EnterpriseActionsRunnerGroup(String name, EnterpriseActionsRunnerGroupArgs args, CustomResourceOptions options)
type: github:EnterpriseActionsRunnerGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EnterpriseActionsRunnerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EnterpriseActionsRunnerGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EnterpriseActionsRunnerGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EnterpriseActionsRunnerGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EnterpriseActionsRunnerGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var enterpriseActionsRunnerGroupResource = new Github.EnterpriseActionsRunnerGroup("enterpriseActionsRunnerGroupResource", new()
{
    EnterpriseSlug = "string",
    Visibility = "string",
    AllowsPublicRepositories = false,
    Name = "string",
    RestrictedToWorkflows = false,
    SelectedOrganizationIds = new[]
    {
        0,
    },
    SelectedWorkflows = new[]
    {
        "string",
    },
});
Copy
example, err := github.NewEnterpriseActionsRunnerGroup(ctx, "enterpriseActionsRunnerGroupResource", &github.EnterpriseActionsRunnerGroupArgs{
	EnterpriseSlug:           pulumi.String("string"),
	Visibility:               pulumi.String("string"),
	AllowsPublicRepositories: pulumi.Bool(false),
	Name:                     pulumi.String("string"),
	RestrictedToWorkflows:    pulumi.Bool(false),
	SelectedOrganizationIds: pulumi.IntArray{
		pulumi.Int(0),
	},
	SelectedWorkflows: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var enterpriseActionsRunnerGroupResource = new EnterpriseActionsRunnerGroup("enterpriseActionsRunnerGroupResource", EnterpriseActionsRunnerGroupArgs.builder()
    .enterpriseSlug("string")
    .visibility("string")
    .allowsPublicRepositories(false)
    .name("string")
    .restrictedToWorkflows(false)
    .selectedOrganizationIds(0)
    .selectedWorkflows("string")
    .build());
Copy
enterprise_actions_runner_group_resource = github.EnterpriseActionsRunnerGroup("enterpriseActionsRunnerGroupResource",
    enterprise_slug="string",
    visibility="string",
    allows_public_repositories=False,
    name="string",
    restricted_to_workflows=False,
    selected_organization_ids=[0],
    selected_workflows=["string"])
Copy
const enterpriseActionsRunnerGroupResource = new github.EnterpriseActionsRunnerGroup("enterpriseActionsRunnerGroupResource", {
    enterpriseSlug: "string",
    visibility: "string",
    allowsPublicRepositories: false,
    name: "string",
    restrictedToWorkflows: false,
    selectedOrganizationIds: [0],
    selectedWorkflows: ["string"],
});
Copy
type: github:EnterpriseActionsRunnerGroup
properties:
    allowsPublicRepositories: false
    enterpriseSlug: string
    name: string
    restrictedToWorkflows: false
    selectedOrganizationIds:
        - 0
    selectedWorkflows:
        - string
    visibility: string
Copy

EnterpriseActionsRunnerGroup Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EnterpriseActionsRunnerGroup resource accepts the following input properties:

EnterpriseSlug This property is required. string
The slug of the enterprise.
Visibility This property is required. string
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
AllowsPublicRepositories bool
Whether public repositories can be added to the runner group. Defaults to false.
Name string
Name of the runner group
RestrictedToWorkflows bool
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
SelectedOrganizationIds List<int>
IDs of the organizations which should be added to the runner group
SelectedWorkflows List<string>
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
EnterpriseSlug This property is required. string
The slug of the enterprise.
Visibility This property is required. string
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
AllowsPublicRepositories bool
Whether public repositories can be added to the runner group. Defaults to false.
Name string
Name of the runner group
RestrictedToWorkflows bool
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
SelectedOrganizationIds []int
IDs of the organizations which should be added to the runner group
SelectedWorkflows []string
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
enterpriseSlug This property is required. String
The slug of the enterprise.
visibility This property is required. String
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
allowsPublicRepositories Boolean
Whether public repositories can be added to the runner group. Defaults to false.
name String
Name of the runner group
restrictedToWorkflows Boolean
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
selectedOrganizationIds List<Integer>
IDs of the organizations which should be added to the runner group
selectedWorkflows List<String>
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
enterpriseSlug This property is required. string
The slug of the enterprise.
visibility This property is required. string
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
allowsPublicRepositories boolean
Whether public repositories can be added to the runner group. Defaults to false.
name string
Name of the runner group
restrictedToWorkflows boolean
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
selectedOrganizationIds number[]
IDs of the organizations which should be added to the runner group
selectedWorkflows string[]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
enterprise_slug This property is required. str
The slug of the enterprise.
visibility This property is required. str
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
allows_public_repositories bool
Whether public repositories can be added to the runner group. Defaults to false.
name str
Name of the runner group
restricted_to_workflows bool
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
selected_organization_ids Sequence[int]
IDs of the organizations which should be added to the runner group
selected_workflows Sequence[str]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
enterpriseSlug This property is required. String
The slug of the enterprise.
visibility This property is required. String
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
allowsPublicRepositories Boolean
Whether public repositories can be added to the runner group. Defaults to false.
name String
Name of the runner group
restrictedToWorkflows Boolean
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
selectedOrganizationIds List<Number>
IDs of the organizations which should be added to the runner group
selectedWorkflows List<String>
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.

Outputs

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

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.
RunnersUrl string
The GitHub API URL for the runner group's runners
SelectedOrganizationsUrl string
The GitHub API URL for the runner group's selected organizations
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.
RunnersUrl string
The GitHub API URL for the runner group's runners
SelectedOrganizationsUrl string
The GitHub API URL for the runner group's selected organizations
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.
runnersUrl String
The GitHub API URL for the runner group's runners
selectedOrganizationsUrl String
The GitHub API URL for the runner group's selected organizations
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.
runnersUrl string
The GitHub API URL for the runner group's runners
selectedOrganizationsUrl string
The GitHub API URL for the runner group's selected organizations
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.
runners_url str
The GitHub API URL for the runner group's runners
selected_organizations_url str
The GitHub API URL for the runner group's selected organizations
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.
runnersUrl String
The GitHub API URL for the runner group's runners
selectedOrganizationsUrl String
The GitHub API URL for the runner group's selected organizations

Look up Existing EnterpriseActionsRunnerGroup Resource

Get an existing EnterpriseActionsRunnerGroup 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?: EnterpriseActionsRunnerGroupState, opts?: CustomResourceOptions): EnterpriseActionsRunnerGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allows_public_repositories: Optional[bool] = None,
        default: Optional[bool] = None,
        enterprise_slug: Optional[str] = None,
        etag: Optional[str] = None,
        name: Optional[str] = None,
        restricted_to_workflows: Optional[bool] = None,
        runners_url: Optional[str] = None,
        selected_organization_ids: Optional[Sequence[int]] = None,
        selected_organizations_url: Optional[str] = None,
        selected_workflows: Optional[Sequence[str]] = None,
        visibility: Optional[str] = None) -> EnterpriseActionsRunnerGroup
func GetEnterpriseActionsRunnerGroup(ctx *Context, name string, id IDInput, state *EnterpriseActionsRunnerGroupState, opts ...ResourceOption) (*EnterpriseActionsRunnerGroup, error)
public static EnterpriseActionsRunnerGroup Get(string name, Input<string> id, EnterpriseActionsRunnerGroupState? state, CustomResourceOptions? opts = null)
public static EnterpriseActionsRunnerGroup get(String name, Output<String> id, EnterpriseActionsRunnerGroupState state, CustomResourceOptions options)
resources:  _:    type: github:EnterpriseActionsRunnerGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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. Defaults to false.
Default bool
Whether this is the default runner group
EnterpriseSlug string
The slug of the enterprise.
Etag string
An etag representing the runner group object
Name string
Name of the runner group
RestrictedToWorkflows bool
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
RunnersUrl string
The GitHub API URL for the runner group's runners
SelectedOrganizationIds List<int>
IDs of the organizations which should be added to the runner group
SelectedOrganizationsUrl string
The GitHub API URL for the runner group's selected organizations
SelectedWorkflows List<string>
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
Visibility string
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
AllowsPublicRepositories bool
Whether public repositories can be added to the runner group. Defaults to false.
Default bool
Whether this is the default runner group
EnterpriseSlug string
The slug of the enterprise.
Etag string
An etag representing the runner group object
Name string
Name of the runner group
RestrictedToWorkflows bool
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
RunnersUrl string
The GitHub API URL for the runner group's runners
SelectedOrganizationIds []int
IDs of the organizations which should be added to the runner group
SelectedOrganizationsUrl string
The GitHub API URL for the runner group's selected organizations
SelectedWorkflows []string
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
Visibility string
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
allowsPublicRepositories Boolean
Whether public repositories can be added to the runner group. Defaults to false.
default_ Boolean
Whether this is the default runner group
enterpriseSlug String
The slug of the enterprise.
etag String
An etag representing the runner group object
name String
Name of the runner group
restrictedToWorkflows Boolean
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
runnersUrl String
The GitHub API URL for the runner group's runners
selectedOrganizationIds List<Integer>
IDs of the organizations which should be added to the runner group
selectedOrganizationsUrl String
The GitHub API URL for the runner group's selected organizations
selectedWorkflows List<String>
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
visibility String
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
allowsPublicRepositories boolean
Whether public repositories can be added to the runner group. Defaults to false.
default boolean
Whether this is the default runner group
enterpriseSlug string
The slug of the enterprise.
etag string
An etag representing the runner group object
name string
Name of the runner group
restrictedToWorkflows boolean
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
runnersUrl string
The GitHub API URL for the runner group's runners
selectedOrganizationIds number[]
IDs of the organizations which should be added to the runner group
selectedOrganizationsUrl string
The GitHub API URL for the runner group's selected organizations
selectedWorkflows string[]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
visibility string
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
allows_public_repositories bool
Whether public repositories can be added to the runner group. Defaults to false.
default bool
Whether this is the default runner group
enterprise_slug str
The slug of the enterprise.
etag str
An etag representing the runner group object
name str
Name of the runner group
restricted_to_workflows bool
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
runners_url str
The GitHub API URL for the runner group's runners
selected_organization_ids Sequence[int]
IDs of the organizations which should be added to the runner group
selected_organizations_url str
The GitHub API URL for the runner group's selected organizations
selected_workflows Sequence[str]
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
visibility str
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected
allowsPublicRepositories Boolean
Whether public repositories can be added to the runner group. Defaults to false.
default Boolean
Whether this is the default runner group
enterpriseSlug String
The slug of the enterprise.
etag String
An etag representing the runner group object
name String
Name of the runner group
restrictedToWorkflows Boolean
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array. Defaults to false.
runnersUrl String
The GitHub API URL for the runner group's runners
selectedOrganizationIds List<Number>
IDs of the organizations which should be added to the runner group
selectedOrganizationsUrl String
The GitHub API URL for the runner group's selected organizations
selectedWorkflows List<String>
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
visibility String
Visibility of a runner group to enterprise organizations. Whether the runner group can include all or selected

Import

This resource can be imported using the enterprise slug and the ID of the runner group:

$ pulumi import github:index/enterpriseActionsRunnerGroup:EnterpriseActionsRunnerGroup test enterprise-slug/42
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
GitHub pulumi/pulumi-github
License
Apache-2.0
Notes
This Pulumi package is based on the github Terraform Provider.