OrganizationSettings

class OrganizationSettings : KotlinCustomResource

This resource allows you to create and manage settings for a GitHub Organization.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.OrganizationSettings;
import com.pulumi.github.OrganizationSettingsArgs;
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 test = new OrganizationSettings("test", OrganizationSettingsArgs.builder()
.advancedSecurityEnabledForNewRepositories(false)
.billingEmail("test@example.com")
.blog("https://example.com")
.company("Test Company")
.defaultRepositoryPermission("read")
.dependabotAlertsEnabledForNewRepositories(false)
.dependabotSecurityUpdatesEnabledForNewRepositories(false)
.dependencyGraphEnabledForNewRepositories(false)
.description("Test Description")
.email("test@example.com")
.hasOrganizationProjects(true)
.hasRepositoryProjects(true)
.location("Test Location")
.membersCanCreateInternalRepositories(true)
.membersCanCreatePages(true)
.membersCanCreatePrivatePages(true)
.membersCanCreatePrivateRepositories(true)
.membersCanCreatePublicPages(true)
.membersCanCreatePublicRepositories(true)
.membersCanCreateRepositories(true)
.membersCanForkPrivateRepositories(true)
.secretScanningEnabledForNewRepositories(false)
.secretScanningPushProtectionEnabledForNewRepositories(false)
.twitterUsername("Test")
.webCommitSignoffRequired(true)
.build());
}
}

Import

Organization settings can be imported using the id of the organization. The id of the organization can be found using the get an organization API.

$ pulumi import github:index/organizationSettings:OrganizationSettings test 123456789

Properties

Whether or not advanced security is enabled for new repositories. Defaults to false.

Link copied to clipboard
val billingEmail: Output<String>

The billing email address for the organization.

Link copied to clipboard
val blog: Output<String>?

The blog URL for the organization.

Link copied to clipboard
val company: Output<String>?

The company name for the organization.

Link copied to clipboard

The default permission for organization members to create new repositories. Can be one of read, write, admin, or none. Defaults to read.

Whether or not dependabot alerts are enabled for new repositories. Defaults to false.

Whether or not dependabot security updates are enabled for new repositories. Defaults to false.

Link copied to clipboard

Whether or not dependency graph is enabled for new repositories. Defaults to false.

Link copied to clipboard
val description: Output<String>?

The description for the organization.

Link copied to clipboard
val email: Output<String>?

The email address for the organization.

Link copied to clipboard

Whether or not organization projects are enabled for the organization.

Link copied to clipboard

Whether or not repository projects are enabled for the organization.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>?

The location for the organization.

Link copied to clipboard

Whether or not organization members can create new internal repositories. For Enterprise Organizations only.

Link copied to clipboard

Whether or not organization members can create new pages. Defaults to true.

Link copied to clipboard

Whether or not organization members can create new private pages. Defaults to true.

Link copied to clipboard

Whether or not organization members can create new private repositories. Defaults to true.

Link copied to clipboard

Whether or not organization members can create new public pages. Defaults to true.

Link copied to clipboard

Whether or not organization members can create new public repositories. Defaults to true.

Link copied to clipboard

Whether or not organization members can create new repositories. Defaults to true.

Link copied to clipboard

Whether or not organization members can fork private repositories. Defaults to false.

Link copied to clipboard
val name: Output<String>

The name for the organization.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Whether or not secret scanning is enabled for new repositories. Defaults to false.

Whether or not secret scanning push protection is enabled for new repositories. Defaults to false.

Link copied to clipboard
val twitterUsername: Output<String>?

The Twitter username for the organization.

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

Whether or not commit signatures are required for commits to the organization. Defaults to false.