Skip to content

organization_network_configuration.html.markdown

Latest commit

 

History

History
56 lines (36 loc) · 2.57 KB

organization_network_configuration.html.markdown

File metadata and controls

56 lines (36 loc) · 2.57 KB
layout github
page_title GitHub: github_organization_network_configuration
description Creates and manages hosted compute network configurations for a GitHub organization.

github_organization_network_configuration

This resource allows you to create and manage hosted compute network configurations for a GitHub Organization. Network configurations allow GitHub-hosted compute services, such as Actions hosted runners, to connect to your private network resources.

~> Note: This resource is organization-only and is available for GitHub Enterprise Cloud organizations. See the GitHub documentation for more information.

Example Usage

resource "github_organization_network_configuration" "example" {
  name                 = "my-network-config"
  compute_service      = "actions"
  network_settings_ids = ["23456789ABCDEF1"]
}

Argument Reference

The following arguments are supported:

  • name - (Required) The name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, ., -, and _.

  • compute_service - (Optional) The hosted compute service to use for the network configuration. Can be one of none or actions. Defaults to none.

  • network_settings_ids - (Required) An array containing exactly one network settings ID. Network settings resources are configured separately through your cloud provider. A network settings resource can only be associated with one network configuration at a time.

Attributes Reference

In addition to the arguments above, the following attributes are exported:

  • id - The ID of the network configuration.

  • created_on - The timestamp when the network configuration was created.

Notes

  • This resource can only be used with organization accounts.
  • GitHub currently allows exactly one network_settings_ids value per organization network configuration.
  • The network_settings_ids value must reference an existing hosted compute network settings resource configured outside this provider.

Import

Organization network configurations can be imported using the network configuration ID:

terraform import github_organization_network_configuration.example 1234567890ABCDEF

The network configuration ID can be found using the list hosted compute network configurations for an organization API.