Skip to content

Latest commit

 

History

History
2396 lines (1517 loc) · 129 KB

organizationSettings.java.md

File metadata and controls

2396 lines (1517 loc) · 129 KB
Raw

organizationSettings Submodule

Constructs

OrganizationSettings

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings github_organization_settings}.

Initializers 

import com.hashicorp.cdktf.providers.github.organization_settings.OrganizationSettings;

OrganizationSettings.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .billingEmail(java.lang.String)
//  .advancedSecurityEnabledForNewRepositories(java.lang.Boolean)
//  .advancedSecurityEnabledForNewRepositories(IResolvable)
//  .blog(java.lang.String)
//  .company(java.lang.String)
//  .defaultRepositoryPermission(java.lang.String)
//  .dependabotAlertsEnabledForNewRepositories(java.lang.Boolean)
//  .dependabotAlertsEnabledForNewRepositories(IResolvable)
//  .dependabotSecurityUpdatesEnabledForNewRepositories(java.lang.Boolean)
//  .dependabotSecurityUpdatesEnabledForNewRepositories(IResolvable)
//  .dependencyGraphEnabledForNewRepositories(java.lang.Boolean)
//  .dependencyGraphEnabledForNewRepositories(IResolvable)
//  .description(java.lang.String)
//  .email(java.lang.String)
//  .hasOrganizationProjects(java.lang.Boolean)
//  .hasOrganizationProjects(IResolvable)
//  .hasRepositoryProjects(java.lang.Boolean)
//  .hasRepositoryProjects(IResolvable)
//  .id(java.lang.String)
//  .location(java.lang.String)
//  .membersCanCreateInternalRepositories(java.lang.Boolean)
//  .membersCanCreateInternalRepositories(IResolvable)
//  .membersCanCreatePages(java.lang.Boolean)
//  .membersCanCreatePages(IResolvable)
//  .membersCanCreatePrivatePages(java.lang.Boolean)
//  .membersCanCreatePrivatePages(IResolvable)
//  .membersCanCreatePrivateRepositories(java.lang.Boolean)
//  .membersCanCreatePrivateRepositories(IResolvable)
//  .membersCanCreatePublicPages(java.lang.Boolean)
//  .membersCanCreatePublicPages(IResolvable)
//  .membersCanCreatePublicRepositories(java.lang.Boolean)
//  .membersCanCreatePublicRepositories(IResolvable)
//  .membersCanCreateRepositories(java.lang.Boolean)
//  .membersCanCreateRepositories(IResolvable)
//  .membersCanForkPrivateRepositories(java.lang.Boolean)
//  .membersCanForkPrivateRepositories(IResolvable)
//  .name(java.lang.String)
//  .secretScanningEnabledForNewRepositories(java.lang.Boolean)
//  .secretScanningEnabledForNewRepositories(IResolvable)
//  .secretScanningPushProtectionEnabledForNewRepositories(java.lang.Boolean)
//  .secretScanningPushProtectionEnabledForNewRepositories(IResolvable)
//  .twitterUsername(java.lang.String)
//  .webCommitSignoffRequired(java.lang.Boolean)
//  .webCommitSignoffRequired(IResolvable)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
billingEmail java.lang.String The billing email address for the organization.
advancedSecurityEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not advanced security is enabled for new repositories.
blog java.lang.String The blog URL for the organization.
company java.lang.String The company name for the organization.
defaultRepositoryPermission java.lang.String The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'.
dependabotAlertsEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not dependabot alerts are enabled for new repositories.
dependabotSecurityUpdatesEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not dependabot security updates are enabled for new repositories.
dependencyGraphEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not dependency graph is enabled for new repositories.
description java.lang.String The description for the organization.
email java.lang.String The email address for the organization.
hasOrganizationProjects java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization projects are enabled for the organization.
hasRepositoryProjects java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not repository projects are enabled for the organization.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#id OrganizationSettings#id}.
location java.lang.String The location for the organization.
membersCanCreateInternalRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
membersCanCreatePages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new pages.
membersCanCreatePrivatePages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new private pages.
membersCanCreatePrivateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new private repositories.
membersCanCreatePublicPages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new public pages.
membersCanCreatePublicRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new public repositories.
membersCanCreateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new repositories.
membersCanForkPrivateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can fork private repositories.
name java.lang.String The name for the organization.
secretScanningEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not secret scanning is enabled for new repositories.
secretScanningPushProtectionEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not secret scanning push protection is enabled for new repositories.
twitterUsername java.lang.String The Twitter username for the organization.
webCommitSignoffRequired java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not commit signatures are required for commits to the organization.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
billingEmailRequired
  • Type: java.lang.String

The billing email address for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#billing_email OrganizationSettings#billing_email}

advancedSecurityEnabledForNewRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not advanced security is enabled for new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#advanced_security_enabled_for_new_repositories OrganizationSettings#advanced_security_enabled_for_new_repositories}

blogOptional
  • Type: java.lang.String

The blog URL for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#blog OrganizationSettings#blog}

companyOptional
  • Type: java.lang.String

The company name for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#company OrganizationSettings#company}

defaultRepositoryPermissionOptional
  • Type: java.lang.String

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://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#default_repository_permission OrganizationSettings#default_repository_permission}

dependabotAlertsEnabledForNewRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not dependabot alerts are enabled for new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#dependabot_alerts_enabled_for_new_repositories OrganizationSettings#dependabot_alerts_enabled_for_new_repositories}

dependabotSecurityUpdatesEnabledForNewRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#dependabot_security_updates_enabled_for_new_repositories OrganizationSettings#dependabot_security_updates_enabled_for_new_repositories}

dependencyGraphEnabledForNewRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not dependency graph is enabled for new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#dependency_graph_enabled_for_new_repositories OrganizationSettings#dependency_graph_enabled_for_new_repositories}

descriptionOptional
  • Type: java.lang.String

The description for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#description OrganizationSettings#description}

emailOptional
  • Type: java.lang.String

The email address for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#email OrganizationSettings#email}

hasOrganizationProjectsOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization projects are enabled for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#has_organization_projects OrganizationSettings#has_organization_projects}

hasRepositoryProjectsOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not repository projects are enabled for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#has_repository_projects OrganizationSettings#has_repository_projects}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/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.

locationOptional
  • Type: java.lang.String

The location for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#location OrganizationSettings#location}

membersCanCreateInternalRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_internal_repositories OrganizationSettings#members_can_create_internal_repositories}

membersCanCreatePagesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new pages.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_pages OrganizationSettings#members_can_create_pages}

membersCanCreatePrivatePagesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new private pages.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_private_pages OrganizationSettings#members_can_create_private_pages}

membersCanCreatePrivateRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new private repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_private_repositories OrganizationSettings#members_can_create_private_repositories}

membersCanCreatePublicPagesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new public pages.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_public_pages OrganizationSettings#members_can_create_public_pages}

membersCanCreatePublicRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new public repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_public_repositories OrganizationSettings#members_can_create_public_repositories}

membersCanCreateRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_repositories OrganizationSettings#members_can_create_repositories}

membersCanForkPrivateRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can fork private repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_fork_private_repositories OrganizationSettings#members_can_fork_private_repositories}

nameOptional
  • Type: java.lang.String

The name for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#name OrganizationSettings#name}

secretScanningEnabledForNewRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not secret scanning is enabled for new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#secret_scanning_enabled_for_new_repositories OrganizationSettings#secret_scanning_enabled_for_new_repositories}

secretScanningPushProtectionEnabledForNewRepositoriesOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#secret_scanning_push_protection_enabled_for_new_repositories OrganizationSettings#secret_scanning_push_protection_enabled_for_new_repositories}

twitterUsernameOptional
  • Type: java.lang.String

The Twitter username for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#twitter_username OrganizationSettings#twitter_username}

webCommitSignoffRequiredOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#web_commit_signoff_required OrganizationSettings#web_commit_signoff_required}

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetAdvancedSecurityEnabledForNewRepositories No description.
resetBlog No description.
resetCompany No description.
resetDefaultRepositoryPermission No description.
resetDependabotAlertsEnabledForNewRepositories No description.
resetDependabotSecurityUpdatesEnabledForNewRepositories No description.
resetDependencyGraphEnabledForNewRepositories No description.
resetDescription No description.
resetEmail No description.
resetHasOrganizationProjects No description.
resetHasRepositoryProjects No description.
resetId No description.
resetLocation No description.
resetMembersCanCreateInternalRepositories No description.
resetMembersCanCreatePages No description.
resetMembersCanCreatePrivatePages No description.
resetMembersCanCreatePrivateRepositories No description.
resetMembersCanCreatePublicPages No description.
resetMembersCanCreatePublicRepositories No description.
resetMembersCanCreateRepositories No description.
resetMembersCanForkPrivateRepositories No description.
resetName No description.
resetSecretScanningEnabledForNewRepositories No description.
resetSecretScanningPushProtectionEnabledForNewRepositories No description.
resetTwitterUsername No description.
resetWebCommitSignoffRequired No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

resetAdvancedSecurityEnabledForNewRepositories 
public void resetAdvancedSecurityEnabledForNewRepositories()
resetBlog 
public void resetBlog()
resetCompany 
public void resetCompany()
resetDefaultRepositoryPermission 
public void resetDefaultRepositoryPermission()
resetDependabotAlertsEnabledForNewRepositories 
public void resetDependabotAlertsEnabledForNewRepositories()
resetDependabotSecurityUpdatesEnabledForNewRepositories 
public void resetDependabotSecurityUpdatesEnabledForNewRepositories()
resetDependencyGraphEnabledForNewRepositories 
public void resetDependencyGraphEnabledForNewRepositories()
resetDescription 
public void resetDescription()
resetEmail 
public void resetEmail()
resetHasOrganizationProjects 
public void resetHasOrganizationProjects()
resetHasRepositoryProjects 
public void resetHasRepositoryProjects()
resetId 
public void resetId()
resetLocation 
public void resetLocation()
resetMembersCanCreateInternalRepositories 
public void resetMembersCanCreateInternalRepositories()
resetMembersCanCreatePages 
public void resetMembersCanCreatePages()
resetMembersCanCreatePrivatePages 
public void resetMembersCanCreatePrivatePages()
resetMembersCanCreatePrivateRepositories 
public void resetMembersCanCreatePrivateRepositories()
resetMembersCanCreatePublicPages 
public void resetMembersCanCreatePublicPages()
resetMembersCanCreatePublicRepositories 
public void resetMembersCanCreatePublicRepositories()
resetMembersCanCreateRepositories 
public void resetMembersCanCreateRepositories()
resetMembersCanForkPrivateRepositories 
public void resetMembersCanForkPrivateRepositories()
resetName 
public void resetName()
resetSecretScanningEnabledForNewRepositories 
public void resetSecretScanningEnabledForNewRepositories()
resetSecretScanningPushProtectionEnabledForNewRepositories 
public void resetSecretScanningPushProtectionEnabledForNewRepositories()
resetTwitterUsername 
public void resetTwitterUsername()
resetWebCommitSignoffRequired 
public void resetWebCommitSignoffRequired()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a OrganizationSettings resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.github.organization_settings.OrganizationSettings;

OrganizationSettings.isConstruct(java.lang.Object x)

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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.github.organization_settings.OrganizationSettings;

OrganizationSettings.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.github.organization_settings.OrganizationSettings;

OrganizationSettings.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.github.organization_settings.OrganizationSettings;

OrganizationSettings.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),OrganizationSettings.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a OrganizationSettings resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the OrganizationSettings to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing OrganizationSettings that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the OrganizationSettings to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
advancedSecurityEnabledForNewRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
billingEmailInput java.lang.String No description.
blogInput java.lang.String No description.
companyInput java.lang.String No description.
defaultRepositoryPermissionInput java.lang.String No description.
dependabotAlertsEnabledForNewRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
dependabotSecurityUpdatesEnabledForNewRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
dependencyGraphEnabledForNewRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
descriptionInput java.lang.String No description.
emailInput java.lang.String No description.
hasOrganizationProjectsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
hasRepositoryProjectsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
locationInput java.lang.String No description.
membersCanCreateInternalRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePagesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePrivatePagesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePrivateRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePublicPagesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePublicRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreateRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanForkPrivateRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nameInput java.lang.String No description.
secretScanningEnabledForNewRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
secretScanningPushProtectionEnabledForNewRepositoriesInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
twitterUsernameInput java.lang.String No description.
webCommitSignoffRequiredInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
advancedSecurityEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
billingEmail java.lang.String No description.
blog java.lang.String No description.
company java.lang.String No description.
defaultRepositoryPermission java.lang.String No description.
dependabotAlertsEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
dependabotSecurityUpdatesEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
dependencyGraphEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
description java.lang.String No description.
email java.lang.String No description.
hasOrganizationProjects java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
hasRepositoryProjects java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
id java.lang.String No description.
location java.lang.String No description.
membersCanCreateInternalRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePrivatePages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePrivateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePublicPages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePublicRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanCreateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
membersCanForkPrivateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
name java.lang.String No description.
secretScanningEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
secretScanningPushProtectionEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
twitterUsername java.lang.String No description.
webCommitSignoffRequired java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
advancedSecurityEnabledForNewRepositoriesInputOptional 
public java.lang.Object getAdvancedSecurityEnabledForNewRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
billingEmailInputOptional 
public java.lang.String getBillingEmailInput();
  • Type: java.lang.String
blogInputOptional 
public java.lang.String getBlogInput();
  • Type: java.lang.String
companyInputOptional 
public java.lang.String getCompanyInput();
  • Type: java.lang.String
defaultRepositoryPermissionInputOptional 
public java.lang.String getDefaultRepositoryPermissionInput();
  • Type: java.lang.String
dependabotAlertsEnabledForNewRepositoriesInputOptional 
public java.lang.Object getDependabotAlertsEnabledForNewRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
dependabotSecurityUpdatesEnabledForNewRepositoriesInputOptional 
public java.lang.Object getDependabotSecurityUpdatesEnabledForNewRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
dependencyGraphEnabledForNewRepositoriesInputOptional 
public java.lang.Object getDependencyGraphEnabledForNewRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
emailInputOptional 
public java.lang.String getEmailInput();
  • Type: java.lang.String
hasOrganizationProjectsInputOptional 
public java.lang.Object getHasOrganizationProjectsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
hasRepositoryProjectsInputOptional 
public java.lang.Object getHasRepositoryProjectsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
locationInputOptional 
public java.lang.String getLocationInput();
  • Type: java.lang.String
membersCanCreateInternalRepositoriesInputOptional 
public java.lang.Object getMembersCanCreateInternalRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePagesInputOptional 
public java.lang.Object getMembersCanCreatePagesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePrivatePagesInputOptional 
public java.lang.Object getMembersCanCreatePrivatePagesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePrivateRepositoriesInputOptional 
public java.lang.Object getMembersCanCreatePrivateRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePublicPagesInputOptional 
public java.lang.Object getMembersCanCreatePublicPagesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePublicRepositoriesInputOptional 
public java.lang.Object getMembersCanCreatePublicRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreateRepositoriesInputOptional 
public java.lang.Object getMembersCanCreateRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanForkPrivateRepositoriesInputOptional 
public java.lang.Object getMembersCanForkPrivateRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
secretScanningEnabledForNewRepositoriesInputOptional 
public java.lang.Object getSecretScanningEnabledForNewRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
secretScanningPushProtectionEnabledForNewRepositoriesInputOptional 
public java.lang.Object getSecretScanningPushProtectionEnabledForNewRepositoriesInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
twitterUsernameInputOptional 
public java.lang.String getTwitterUsernameInput();
  • Type: java.lang.String
webCommitSignoffRequiredInputOptional 
public java.lang.Object getWebCommitSignoffRequiredInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
advancedSecurityEnabledForNewRepositoriesRequired 
public java.lang.Object getAdvancedSecurityEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
billingEmailRequired 
public java.lang.String getBillingEmail();
  • Type: java.lang.String
blogRequired 
public java.lang.String getBlog();
  • Type: java.lang.String
companyRequired 
public java.lang.String getCompany();
  • Type: java.lang.String
defaultRepositoryPermissionRequired 
public java.lang.String getDefaultRepositoryPermission();
  • Type: java.lang.String
dependabotAlertsEnabledForNewRepositoriesRequired 
public java.lang.Object getDependabotAlertsEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
dependabotSecurityUpdatesEnabledForNewRepositoriesRequired 
public java.lang.Object getDependabotSecurityUpdatesEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
dependencyGraphEnabledForNewRepositoriesRequired 
public java.lang.Object getDependencyGraphEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
emailRequired 
public java.lang.String getEmail();
  • Type: java.lang.String
hasOrganizationProjectsRequired 
public java.lang.Object getHasOrganizationProjects();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
hasRepositoryProjectsRequired 
public java.lang.Object getHasRepositoryProjects();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
locationRequired 
public java.lang.String getLocation();
  • Type: java.lang.String
membersCanCreateInternalRepositoriesRequired 
public java.lang.Object getMembersCanCreateInternalRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePagesRequired 
public java.lang.Object getMembersCanCreatePages();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePrivatePagesRequired 
public java.lang.Object getMembersCanCreatePrivatePages();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePrivateRepositoriesRequired 
public java.lang.Object getMembersCanCreatePrivateRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePublicPagesRequired 
public java.lang.Object getMembersCanCreatePublicPages();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreatePublicRepositoriesRequired 
public java.lang.Object getMembersCanCreatePublicRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanCreateRepositoriesRequired 
public java.lang.Object getMembersCanCreateRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
membersCanForkPrivateRepositoriesRequired 
public java.lang.Object getMembersCanForkPrivateRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
secretScanningEnabledForNewRepositoriesRequired 
public java.lang.Object getSecretScanningEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
secretScanningPushProtectionEnabledForNewRepositoriesRequired 
public java.lang.Object getSecretScanningPushProtectionEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
twitterUsernameRequired 
public java.lang.String getTwitterUsername();
  • Type: java.lang.String
webCommitSignoffRequiredRequired 
public java.lang.Object getWebCommitSignoffRequired();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

OrganizationSettingsConfig

Initializer 

import com.hashicorp.cdktf.providers.github.organization_settings.OrganizationSettingsConfig;

OrganizationSettingsConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .billingEmail(java.lang.String)
//  .advancedSecurityEnabledForNewRepositories(java.lang.Boolean)
//  .advancedSecurityEnabledForNewRepositories(IResolvable)
//  .blog(java.lang.String)
//  .company(java.lang.String)
//  .defaultRepositoryPermission(java.lang.String)
//  .dependabotAlertsEnabledForNewRepositories(java.lang.Boolean)
//  .dependabotAlertsEnabledForNewRepositories(IResolvable)
//  .dependabotSecurityUpdatesEnabledForNewRepositories(java.lang.Boolean)
//  .dependabotSecurityUpdatesEnabledForNewRepositories(IResolvable)
//  .dependencyGraphEnabledForNewRepositories(java.lang.Boolean)
//  .dependencyGraphEnabledForNewRepositories(IResolvable)
//  .description(java.lang.String)
//  .email(java.lang.String)
//  .hasOrganizationProjects(java.lang.Boolean)
//  .hasOrganizationProjects(IResolvable)
//  .hasRepositoryProjects(java.lang.Boolean)
//  .hasRepositoryProjects(IResolvable)
//  .id(java.lang.String)
//  .location(java.lang.String)
//  .membersCanCreateInternalRepositories(java.lang.Boolean)
//  .membersCanCreateInternalRepositories(IResolvable)
//  .membersCanCreatePages(java.lang.Boolean)
//  .membersCanCreatePages(IResolvable)
//  .membersCanCreatePrivatePages(java.lang.Boolean)
//  .membersCanCreatePrivatePages(IResolvable)
//  .membersCanCreatePrivateRepositories(java.lang.Boolean)
//  .membersCanCreatePrivateRepositories(IResolvable)
//  .membersCanCreatePublicPages(java.lang.Boolean)
//  .membersCanCreatePublicPages(IResolvable)
//  .membersCanCreatePublicRepositories(java.lang.Boolean)
//  .membersCanCreatePublicRepositories(IResolvable)
//  .membersCanCreateRepositories(java.lang.Boolean)
//  .membersCanCreateRepositories(IResolvable)
//  .membersCanForkPrivateRepositories(java.lang.Boolean)
//  .membersCanForkPrivateRepositories(IResolvable)
//  .name(java.lang.String)
//  .secretScanningEnabledForNewRepositories(java.lang.Boolean)
//  .secretScanningEnabledForNewRepositories(IResolvable)
//  .secretScanningPushProtectionEnabledForNewRepositories(java.lang.Boolean)
//  .secretScanningPushProtectionEnabledForNewRepositories(IResolvable)
//  .twitterUsername(java.lang.String)
//  .webCommitSignoffRequired(java.lang.Boolean)
//  .webCommitSignoffRequired(IResolvable)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
billingEmail java.lang.String The billing email address for the organization.
advancedSecurityEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not advanced security is enabled for new repositories.
blog java.lang.String The blog URL for the organization.
company java.lang.String The company name for the organization.
defaultRepositoryPermission java.lang.String The default permission for organization members to create new repositories. Can be one of 'read', 'write', 'admin' or 'none'.
dependabotAlertsEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not dependabot alerts are enabled for new repositories.
dependabotSecurityUpdatesEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not dependabot security updates are enabled for new repositories.
dependencyGraphEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not dependency graph is enabled for new repositories.
description java.lang.String The description for the organization.
email java.lang.String The email address for the organization.
hasOrganizationProjects java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization projects are enabled for the organization.
hasRepositoryProjects java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not repository projects are enabled for the organization.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#id OrganizationSettings#id}.
location java.lang.String The location for the organization.
membersCanCreateInternalRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new internal repositories. For Enterprise Organizations only.
membersCanCreatePages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new pages.
membersCanCreatePrivatePages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new private pages.
membersCanCreatePrivateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new private repositories.
membersCanCreatePublicPages java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new public pages.
membersCanCreatePublicRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new public repositories.
membersCanCreateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can create new repositories.
membersCanForkPrivateRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not organization members can fork private repositories.
name java.lang.String The name for the organization.
secretScanningEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not secret scanning is enabled for new repositories.
secretScanningPushProtectionEnabledForNewRepositories java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not secret scanning push protection is enabled for new repositories.
twitterUsername java.lang.String The Twitter username for the organization.
webCommitSignoffRequired java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether or not commit signatures are required for commits to the organization.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
billingEmailRequired 
public java.lang.String getBillingEmail();
  • Type: java.lang.String

The billing email address for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#billing_email OrganizationSettings#billing_email}

advancedSecurityEnabledForNewRepositoriesOptional 
public java.lang.Object getAdvancedSecurityEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not advanced security is enabled for new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#advanced_security_enabled_for_new_repositories OrganizationSettings#advanced_security_enabled_for_new_repositories}

blogOptional 
public java.lang.String getBlog();
  • Type: java.lang.String

The blog URL for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#blog OrganizationSettings#blog}

companyOptional 
public java.lang.String getCompany();
  • Type: java.lang.String

The company name for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#company OrganizationSettings#company}

defaultRepositoryPermissionOptional 
public java.lang.String getDefaultRepositoryPermission();
  • Type: java.lang.String

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://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#default_repository_permission OrganizationSettings#default_repository_permission}

dependabotAlertsEnabledForNewRepositoriesOptional 
public java.lang.Object getDependabotAlertsEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not dependabot alerts are enabled for new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#dependabot_alerts_enabled_for_new_repositories OrganizationSettings#dependabot_alerts_enabled_for_new_repositories}

dependabotSecurityUpdatesEnabledForNewRepositoriesOptional 
public java.lang.Object getDependabotSecurityUpdatesEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#dependabot_security_updates_enabled_for_new_repositories OrganizationSettings#dependabot_security_updates_enabled_for_new_repositories}

dependencyGraphEnabledForNewRepositoriesOptional 
public java.lang.Object getDependencyGraphEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not dependency graph is enabled for new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#dependency_graph_enabled_for_new_repositories OrganizationSettings#dependency_graph_enabled_for_new_repositories}

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

The description for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#description OrganizationSettings#description}

emailOptional 
public java.lang.String getEmail();
  • Type: java.lang.String

The email address for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#email OrganizationSettings#email}

hasOrganizationProjectsOptional 
public java.lang.Object getHasOrganizationProjects();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization projects are enabled for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#has_organization_projects OrganizationSettings#has_organization_projects}

hasRepositoryProjectsOptional 
public java.lang.Object getHasRepositoryProjects();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not repository projects are enabled for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#has_repository_projects OrganizationSettings#has_repository_projects}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/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.

locationOptional 
public java.lang.String getLocation();
  • Type: java.lang.String

The location for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#location OrganizationSettings#location}

membersCanCreateInternalRepositoriesOptional 
public java.lang.Object getMembersCanCreateInternalRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_internal_repositories OrganizationSettings#members_can_create_internal_repositories}

membersCanCreatePagesOptional 
public java.lang.Object getMembersCanCreatePages();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new pages.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_pages OrganizationSettings#members_can_create_pages}

membersCanCreatePrivatePagesOptional 
public java.lang.Object getMembersCanCreatePrivatePages();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new private pages.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_private_pages OrganizationSettings#members_can_create_private_pages}

membersCanCreatePrivateRepositoriesOptional 
public java.lang.Object getMembersCanCreatePrivateRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new private repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_private_repositories OrganizationSettings#members_can_create_private_repositories}

membersCanCreatePublicPagesOptional 
public java.lang.Object getMembersCanCreatePublicPages();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new public pages.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_public_pages OrganizationSettings#members_can_create_public_pages}

membersCanCreatePublicRepositoriesOptional 
public java.lang.Object getMembersCanCreatePublicRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new public repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_public_repositories OrganizationSettings#members_can_create_public_repositories}

membersCanCreateRepositoriesOptional 
public java.lang.Object getMembersCanCreateRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can create new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_create_repositories OrganizationSettings#members_can_create_repositories}

membersCanForkPrivateRepositoriesOptional 
public java.lang.Object getMembersCanForkPrivateRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not organization members can fork private repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#members_can_fork_private_repositories OrganizationSettings#members_can_fork_private_repositories}

nameOptional 
public java.lang.String getName();
  • Type: java.lang.String

The name for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#name OrganizationSettings#name}

secretScanningEnabledForNewRepositoriesOptional 
public java.lang.Object getSecretScanningEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether or not secret scanning is enabled for new repositories.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#secret_scanning_enabled_for_new_repositories OrganizationSettings#secret_scanning_enabled_for_new_repositories}

secretScanningPushProtectionEnabledForNewRepositoriesOptional 
public java.lang.Object getSecretScanningPushProtectionEnabledForNewRepositories();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#secret_scanning_push_protection_enabled_for_new_repositories OrganizationSettings#secret_scanning_push_protection_enabled_for_new_repositories}

twitterUsernameOptional 
public java.lang.String getTwitterUsername();
  • Type: java.lang.String

The Twitter username for the organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#twitter_username OrganizationSettings#twitter_username}

webCommitSignoffRequiredOptional 
public java.lang.Object getWebCommitSignoffRequired();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/resources/organization_settings#web_commit_signoff_required OrganizationSettings#web_commit_signoff_required}