organizationsettings

package
v7.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 12, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

README

github_organization_settings

Refer to the Terraform Registory for docs: github_organization_settings.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewOrganizationSettings_Override 

func NewOrganizationSettings_Override(o OrganizationSettings, scope constructs.Construct, id *string, config *OrganizationSettingsConfig)

Create a new {@link https://www.terraform.io/docs/providers/github/r/organization_settings github_organization_settings} Resource.

func OrganizationSettings_IsConstruct 

func OrganizationSettings_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func OrganizationSettings_IsTerraformElement 

func OrganizationSettings_IsTerraformElement(x interface{}) *bool

Experimental.

func OrganizationSettings_IsTerraformResource 

func OrganizationSettings_IsTerraformResource(x interface{}) *bool

Experimental.

func OrganizationSettings_TfResourceType 

func OrganizationSettings_TfResourceType() *string

Types

type OrganizationSettings 

type OrganizationSettings interface {
	cdktf.TerraformResource
	AdvancedSecurityEnabledForNewRepositories() interface{}
	SetAdvancedSecurityEnabledForNewRepositories(val interface{})
	AdvancedSecurityEnabledForNewRepositoriesInput() interface{}
	BillingEmail() *string
	SetBillingEmail(val *string)
	BillingEmailInput() *string
	Blog() *string
	SetBlog(val *string)
	BlogInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Company() *string
	SetCompany(val *string)
	CompanyInput() *string
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() *float64
	// Experimental.
	SetCount(val *float64)
	DefaultRepositoryPermission() *string
	SetDefaultRepositoryPermission(val *string)
	DefaultRepositoryPermissionInput() *string
	DependabotAlertsEnabledForNewRepositories() interface{}
	SetDependabotAlertsEnabledForNewRepositories(val interface{})
	DependabotAlertsEnabledForNewRepositoriesInput() interface{}
	DependabotSecurityUpdatesEnabledForNewRepositories() interface{}
	SetDependabotSecurityUpdatesEnabledForNewRepositories(val interface{})
	DependabotSecurityUpdatesEnabledForNewRepositoriesInput() interface{}
	DependencyGraphEnabledForNewRepositories() interface{}
	SetDependencyGraphEnabledForNewRepositories(val interface{})
	DependencyGraphEnabledForNewRepositoriesInput() interface{}
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	Email() *string
	SetEmail(val *string)
	EmailInput() *string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	HasOrganizationProjects() interface{}
	SetHasOrganizationProjects(val interface{})
	HasOrganizationProjectsInput() interface{}
	HasRepositoryProjects() interface{}
	SetHasRepositoryProjects(val interface{})
	HasRepositoryProjectsInput() interface{}
	Id() *string
	SetId(val *string)
	IdInput() *string
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Location() *string
	SetLocation(val *string)
	LocationInput() *string
	MembersCanCreateInternalRepositories() interface{}
	SetMembersCanCreateInternalRepositories(val interface{})
	MembersCanCreateInternalRepositoriesInput() interface{}
	MembersCanCreatePages() interface{}
	SetMembersCanCreatePages(val interface{})
	MembersCanCreatePagesInput() interface{}
	MembersCanCreatePrivatePages() interface{}
	SetMembersCanCreatePrivatePages(val interface{})
	MembersCanCreatePrivatePagesInput() interface{}
	MembersCanCreatePrivateRepositories() interface{}
	SetMembersCanCreatePrivateRepositories(val interface{})
	MembersCanCreatePrivateRepositoriesInput() interface{}
	MembersCanCreatePublicPages() interface{}
	SetMembersCanCreatePublicPages(val interface{})
	MembersCanCreatePublicPagesInput() interface{}
	MembersCanCreatePublicRepositories() interface{}
	SetMembersCanCreatePublicRepositories(val interface{})
	MembersCanCreatePublicRepositoriesInput() interface{}
	MembersCanCreateRepositories() interface{}
	SetMembersCanCreateRepositories(val interface{})
	MembersCanCreateRepositoriesInput() interface{}
	MembersCanForkPrivateRepositories() interface{}
	SetMembersCanForkPrivateRepositories(val interface{})
	MembersCanForkPrivateRepositoriesInput() interface{}
	Name() *string
	SetName(val *string)
	NameInput() *string
	// The tree node.
	Node() constructs.Node
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	SecretScanningEnabledForNewRepositories() interface{}
	SetSecretScanningEnabledForNewRepositories(val interface{})
	SecretScanningEnabledForNewRepositoriesInput() interface{}
	SecretScanningPushProtectionEnabledForNewRepositories() interface{}
	SetSecretScanningPushProtectionEnabledForNewRepositories(val interface{})
	SecretScanningPushProtectionEnabledForNewRepositoriesInput() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	TwitterUsername() *string
	SetTwitterUsername(val *string)
	TwitterUsernameInput() *string
	WebCommitSignoffRequired() interface{}
	SetWebCommitSignoffRequired(val interface{})
	WebCommitSignoffRequiredInput() interface{}
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAdvancedSecurityEnabledForNewRepositories()
	ResetBlog()
	ResetCompany()
	ResetDefaultRepositoryPermission()
	ResetDependabotAlertsEnabledForNewRepositories()
	ResetDependabotSecurityUpdatesEnabledForNewRepositories()
	ResetDependencyGraphEnabledForNewRepositories()
	ResetDescription()
	ResetEmail()
	ResetHasOrganizationProjects()
	ResetHasRepositoryProjects()
	ResetId()
	ResetLocation()
	ResetMembersCanCreateInternalRepositories()
	ResetMembersCanCreatePages()
	ResetMembersCanCreatePrivatePages()
	ResetMembersCanCreatePrivateRepositories()
	ResetMembersCanCreatePublicPages()
	ResetMembersCanCreatePublicRepositories()
	ResetMembersCanCreateRepositories()
	ResetMembersCanForkPrivateRepositories()
	ResetName()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetSecretScanningEnabledForNewRepositories()
	ResetSecretScanningPushProtectionEnabledForNewRepositories()
	ResetTwitterUsername()
	ResetWebCommitSignoffRequired()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://www.terraform.io/docs/providers/github/r/organization_settings github_organization_settings}.

func NewOrganizationSettings 

func NewOrganizationSettings(scope constructs.Construct, id *string, config *OrganizationSettingsConfig) OrganizationSettings

Create a new {@link https://www.terraform.io/docs/providers/github/r/organization_settings github_organization_settings} Resource.

type OrganizationSettingsConfig 

type OrganizationSettingsConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count *float64 `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// The billing email address for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#billing_email OrganizationSettings#billing_email}
	BillingEmail *string `field:"required" json:"billingEmail" yaml:"billingEmail"`
	// Whether or not advanced security is enabled for new repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#advanced_security_enabled_for_new_repositories OrganizationSettings#advanced_security_enabled_for_new_repositories}
	AdvancedSecurityEnabledForNewRepositories interface{} `field:"optional" json:"advancedSecurityEnabledForNewRepositories" yaml:"advancedSecurityEnabledForNewRepositories"`
	// The blog URL for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#blog OrganizationSettings#blog}
	Blog *string `field:"optional" json:"blog" yaml:"blog"`
	// The company name for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#company OrganizationSettings#company}
	Company *string `field:"optional" json:"company" yaml:"company"`
	// The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#default_repository_permission OrganizationSettings#default_repository_permission}
	DefaultRepositoryPermission *string `field:"optional" json:"defaultRepositoryPermission" yaml:"defaultRepositoryPermission"`
	// Whether or not dependabot alerts are enabled for new repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#dependabot_alerts_enabled_for_new_repositories OrganizationSettings#dependabot_alerts_enabled_for_new_repositories}
	DependabotAlertsEnabledForNewRepositories interface{} `field:"optional" json:"dependabotAlertsEnabledForNewRepositories" yaml:"dependabotAlertsEnabledForNewRepositories"`
	// Whether or not dependabot security updates are enabled for new repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#dependabot_security_updates_enabled_for_new_repositories OrganizationSettings#dependabot_security_updates_enabled_for_new_repositories}
	DependabotSecurityUpdatesEnabledForNewRepositories interface{} `` /* 132-byte string literal not displayed */
	// Whether or not dependency graph is enabled for new repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#dependency_graph_enabled_for_new_repositories OrganizationSettings#dependency_graph_enabled_for_new_repositories}
	DependencyGraphEnabledForNewRepositories interface{} `field:"optional" json:"dependencyGraphEnabledForNewRepositories" yaml:"dependencyGraphEnabledForNewRepositories"`
	// The description for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#description OrganizationSettings#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The email address for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#email OrganizationSettings#email}
	Email *string `field:"optional" json:"email" yaml:"email"`
	// Whether or not organization projects are enabled for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#has_organization_projects OrganizationSettings#has_organization_projects}
	HasOrganizationProjects interface{} `field:"optional" json:"hasOrganizationProjects" yaml:"hasOrganizationProjects"`
	// Whether or not repository projects are enabled for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#has_repository_projects OrganizationSettings#has_repository_projects}
	HasRepositoryProjects interface{} `field:"optional" json:"hasRepositoryProjects" yaml:"hasRepositoryProjects"`
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#id OrganizationSettings#id}.
	//
	// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
	// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// The location for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#location OrganizationSettings#location}
	Location *string `field:"optional" json:"location" yaml:"location"`
	// Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#members_can_create_internal_repositories OrganizationSettings#members_can_create_internal_repositories}
	MembersCanCreateInternalRepositories interface{} `field:"optional" json:"membersCanCreateInternalRepositories" yaml:"membersCanCreateInternalRepositories"`
	// Whether or not organization members can create new pages.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#members_can_create_pages OrganizationSettings#members_can_create_pages}
	MembersCanCreatePages interface{} `field:"optional" json:"membersCanCreatePages" yaml:"membersCanCreatePages"`
	// Whether or not organization members can create new private pages.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#members_can_create_private_pages OrganizationSettings#members_can_create_private_pages}
	MembersCanCreatePrivatePages interface{} `field:"optional" json:"membersCanCreatePrivatePages" yaml:"membersCanCreatePrivatePages"`
	// Whether or not organization members can create new private repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#members_can_create_private_repositories OrganizationSettings#members_can_create_private_repositories}
	MembersCanCreatePrivateRepositories interface{} `field:"optional" json:"membersCanCreatePrivateRepositories" yaml:"membersCanCreatePrivateRepositories"`
	// Whether or not organization members can create new public pages.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#members_can_create_public_pages OrganizationSettings#members_can_create_public_pages}
	MembersCanCreatePublicPages interface{} `field:"optional" json:"membersCanCreatePublicPages" yaml:"membersCanCreatePublicPages"`
	// Whether or not organization members can create new public repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#members_can_create_public_repositories OrganizationSettings#members_can_create_public_repositories}
	MembersCanCreatePublicRepositories interface{} `field:"optional" json:"membersCanCreatePublicRepositories" yaml:"membersCanCreatePublicRepositories"`
	// Whether or not organization members can create new repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#members_can_create_repositories OrganizationSettings#members_can_create_repositories}
	MembersCanCreateRepositories interface{} `field:"optional" json:"membersCanCreateRepositories" yaml:"membersCanCreateRepositories"`
	// Whether or not organization members can fork private repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#members_can_fork_private_repositories OrganizationSettings#members_can_fork_private_repositories}
	MembersCanForkPrivateRepositories interface{} `field:"optional" json:"membersCanForkPrivateRepositories" yaml:"membersCanForkPrivateRepositories"`
	// The name for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#name OrganizationSettings#name}
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Whether or not secret scanning is enabled for new repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#secret_scanning_enabled_for_new_repositories OrganizationSettings#secret_scanning_enabled_for_new_repositories}
	SecretScanningEnabledForNewRepositories interface{} `field:"optional" json:"secretScanningEnabledForNewRepositories" yaml:"secretScanningEnabledForNewRepositories"`
	// Whether or not secret scanning push protection is enabled for new repositories.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#secret_scanning_push_protection_enabled_for_new_repositories OrganizationSettings#secret_scanning_push_protection_enabled_for_new_repositories}
	SecretScanningPushProtectionEnabledForNewRepositories interface{} `` /* 138-byte string literal not displayed */
	// The Twitter username for the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#twitter_username OrganizationSettings#twitter_username}
	TwitterUsername *string `field:"optional" json:"twitterUsername" yaml:"twitterUsername"`
	// Whether or not commit signatures are required for commits to the organization.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/github/r/organization_settings#web_commit_signoff_required OrganizationSettings#web_commit_signoff_required}
	WebCommitSignoffRequired interface{} `field:"optional" json:"webCommitSignoffRequired" yaml:"webCommitSignoffRequired"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.