pulumi-github-kotlin/com.pulumi.github.kotlin/OrganizationSettingsArgs

OrganizationSettingsArgs

data class OrganizationSettingsArgs(val advancedSecurityEnabledForNewRepositories: Output<Boolean>? = null, val billingEmail: Output<String>? = null, val blog: Output<String>? = null, val company: Output<String>? = null, val defaultRepositoryPermission: Output<String>? = null, val dependabotAlertsEnabledForNewRepositories: Output<Boolean>? = null, val dependabotSecurityUpdatesEnabledForNewRepositories: Output<Boolean>? = null, val dependencyGraphEnabledForNewRepositories: Output<Boolean>? = null, val description: Output<String>? = null, val email: Output<String>? = null, val hasOrganizationProjects: Output<Boolean>? = null, val hasRepositoryProjects: Output<Boolean>? = null, val location: Output<String>? = null, val membersCanCreateInternalRepositories: Output<Boolean>? = null, val membersCanCreatePages: Output<Boolean>? = null, val membersCanCreatePrivatePages: Output<Boolean>? = null, val membersCanCreatePrivateRepositories: Output<Boolean>? = null, val membersCanCreatePublicPages: Output<Boolean>? = null, val membersCanCreatePublicRepositories: Output<Boolean>? = null, val membersCanCreateRepositories: Output<Boolean>? = null, val membersCanForkPrivateRepositories: Output<Boolean>? = null, val name: Output<String>? = null, val secretScanningEnabledForNewRepositories: Output<Boolean>? = null, val secretScanningPushProtectionEnabledForNewRepositories: Output<Boolean>? = null, val twitterUsername: Output<String>? = null, val webCommitSignoffRequired: Output<Boolean>? = null) : ConvertibleToJava<OrganizationSettingsArgs>

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());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun OrganizationSettingsArgs(advancedSecurityEnabledForNewRepositories: Output<Boolean>? = null, billingEmail: Output<String>? = null, blog: Output<String>? = null, company: Output<String>? = null, defaultRepositoryPermission: Output<String>? = null, dependabotAlertsEnabledForNewRepositories: Output<Boolean>? = null, dependabotSecurityUpdatesEnabledForNewRepositories: Output<Boolean>? = null, dependencyGraphEnabledForNewRepositories: Output<Boolean>? = null, description: Output<String>? = null, email: Output<String>? = null, hasOrganizationProjects: Output<Boolean>? = null, hasRepositoryProjects: Output<Boolean>? = null, location: Output<String>? = null, membersCanCreateInternalRepositories: Output<Boolean>? = null, membersCanCreatePages: Output<Boolean>? = null, membersCanCreatePrivatePages: Output<Boolean>? = null, membersCanCreatePrivateRepositories: Output<Boolean>? = null, membersCanCreatePublicPages: Output<Boolean>? = null, membersCanCreatePublicRepositories: Output<Boolean>? = null, membersCanCreateRepositories: Output<Boolean>? = null, membersCanForkPrivateRepositories: Output<Boolean>? = null, name: Output<String>? = null, secretScanningEnabledForNewRepositories: Output<Boolean>? = null, secretScanningPushProtectionEnabledForNewRepositories: Output<Boolean>? = null, twitterUsername: Output<String>? = null, webCommitSignoffRequired: Output<Boolean>? = null)

Functions

Link copied to clipboard
open override fun toJava(): OrganizationSettingsArgs

Properties

val advancedSecurityEnabledForNewRepositories: Output<Boolean>? = null

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

Link copied to clipboard
val billingEmail: Output<String>? = null

The billing email address for the organization.

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

The blog URL for the organization.

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

The company name for the organization.

Link copied to clipboard
val defaultRepositoryPermission: Output<String>? = null

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

val dependabotAlertsEnabledForNewRepositories: Output<Boolean>? = null

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

val dependabotSecurityUpdatesEnabledForNewRepositories: Output<Boolean>? = null

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

Link copied to clipboard
val dependencyGraphEnabledForNewRepositories: Output<Boolean>? = null

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

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

The description for the organization.

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

The email address for the organization.

Link copied to clipboard
val hasOrganizationProjects: Output<Boolean>? = null

Whether or not organization projects are enabled for the organization.

Link copied to clipboard
val hasRepositoryProjects: Output<Boolean>? = null

Whether or not repository projects are enabled for the organization.

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

The location for the organization.

Link copied to clipboard
val membersCanCreateInternalRepositories: Output<Boolean>? = null

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

Link copied to clipboard
val membersCanCreatePages: Output<Boolean>? = null

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

Link copied to clipboard
val membersCanCreatePrivatePages: Output<Boolean>? = null

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

Link copied to clipboard
val membersCanCreatePrivateRepositories: Output<Boolean>? = null

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

Link copied to clipboard
val membersCanCreatePublicPages: Output<Boolean>? = null

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

Link copied to clipboard
val membersCanCreatePublicRepositories: Output<Boolean>? = null

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

Link copied to clipboard
val membersCanCreateRepositories: Output<Boolean>? = null

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

Link copied to clipboard
val membersCanForkPrivateRepositories: Output<Boolean>? = null

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

Link copied to clipboard
val name: Output<String>? = null

The name for the organization.

Link copied to clipboard
val secretScanningEnabledForNewRepositories: Output<Boolean>? = null

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

val secretScanningPushProtectionEnabledForNewRepositories: Output<Boolean>? = null

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

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

The Twitter username for the organization.

Link copied to clipboard
val webCommitSignoffRequired: Output<Boolean>? = null

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