dataGithubOrganization.csharp.md

dataGithubOrganization Submodule

Constructs

DataGithubOrganization

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization github_organization}.

Initializers

using HashiCorp.Cdktf.Providers.Github;

new DataGithubOrganization(Construct Scope, string Id, DataGithubOrganizationConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	DataGithubOrganizationConfig	No description.

---

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

Id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

Config^Required

• Type: DataGithubOrganizationConfig

---

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	Adds this resource to the terraform JSON output.
ToMetadata	No description.
ToTerraform	Adds this resource to the terraform JSON output.
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.
InterpolationForAttribute	No description.
ResetId	No description.
ResetIgnoreArchivedRepos	No description.
ResetSummaryOnly	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

ResetOverrideLogicalId

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

ResetId

private void ResetId()

ResetIgnoreArchivedRepos

private void ResetIgnoreArchivedRepos()

ResetSummaryOnly

private void ResetSummaryOnly()

Static Functions

Name	Description
IsConstruct	Checks if x is a construct.
IsTerraformElement	No description.
IsTerraformDataSource	No description.
GenerateConfigForImport	Generates CDKTF code for importing a DataGithubOrganization resource upon running "cdktf plan ".

---

IsConstruct

using HashiCorp.Cdktf.Providers.Github;

DataGithubOrganization.IsConstruct(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.

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Github;

DataGithubOrganization.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using HashiCorp.Cdktf.Providers.Github;

DataGithubOrganization.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Github;

DataGithubOrganization.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

ImportToId^Required

• Type: string

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

---

ImportFromId^Required

• Type: string

The id of the existing DataGithubOrganization that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#import import section} in the documentation of this resource for the id to use

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	Constructs.Node	The tree node.
CdktfStack	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
AdvancedSecurityEnabledForNewRepositories	HashiCorp.Cdktf.IResolvable	No description.
DefaultRepositoryPermission	string	No description.
DependabotAlertsEnabledForNewRepositories	HashiCorp.Cdktf.IResolvable	No description.
DependabotSecurityUpdatesEnabledForNewRepositories	HashiCorp.Cdktf.IResolvable	No description.
DependencyGraphEnabledForNewRepositories	HashiCorp.Cdktf.IResolvable	No description.
Description	string	No description.
Login	string	No description.
Members	string[]	No description.
MembersAllowedRepositoryCreationType	string	No description.
MembersCanCreateInternalRepositories	HashiCorp.Cdktf.IResolvable	No description.
MembersCanCreatePages	HashiCorp.Cdktf.IResolvable	No description.
MembersCanCreatePrivatePages	HashiCorp.Cdktf.IResolvable	No description.
MembersCanCreatePrivateRepositories	HashiCorp.Cdktf.IResolvable	No description.
MembersCanCreatePublicPages	HashiCorp.Cdktf.IResolvable	No description.
MembersCanCreatePublicRepositories	HashiCorp.Cdktf.IResolvable	No description.
MembersCanCreateRepositories	HashiCorp.Cdktf.IResolvable	No description.
MembersCanForkPrivateRepositories	HashiCorp.Cdktf.IResolvable	No description.
NodeId	string	No description.
Orgname	string	No description.
Plan	string	No description.
Repositories	string[]	No description.
SecretScanningEnabledForNewRepositories	HashiCorp.Cdktf.IResolvable	No description.
SecretScanningPushProtectionEnabledForNewRepositories	HashiCorp.Cdktf.IResolvable	No description.
TwoFactorRequirementEnabled	HashiCorp.Cdktf.IResolvable	No description.
Users	HashiCorp.Cdktf.StringMapList	No description.
WebCommitSignoffRequired	HashiCorp.Cdktf.IResolvable	No description.
IdInput	string	No description.
IgnoreArchivedReposInput	object	No description.
NameInput	string	No description.
SummaryOnlyInput	object	No description.
Id	string	No description.
IgnoreArchivedRepos	object	No description.
Name	string	No description.
SummaryOnly	object	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

AdvancedSecurityEnabledForNewRepositories^Required

public IResolvable AdvancedSecurityEnabledForNewRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

DefaultRepositoryPermission^Required

public string DefaultRepositoryPermission { get; }

• Type: string

---

DependabotAlertsEnabledForNewRepositories^Required

public IResolvable DependabotAlertsEnabledForNewRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

DependabotSecurityUpdatesEnabledForNewRepositories^Required

public IResolvable DependabotSecurityUpdatesEnabledForNewRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

DependencyGraphEnabledForNewRepositories^Required

public IResolvable DependencyGraphEnabledForNewRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

Description^Required

public string Description { get; }

• Type: string

---

Login^Required

public string Login { get; }

• Type: string

---

Members^Required

public string[] Members { get; }

• Type: string[]

---

MembersAllowedRepositoryCreationType^Required

public string MembersAllowedRepositoryCreationType { get; }

• Type: string

---

MembersCanCreateInternalRepositories^Required

public IResolvable MembersCanCreateInternalRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

MembersCanCreatePages^Required

public IResolvable MembersCanCreatePages { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

MembersCanCreatePrivatePages^Required

public IResolvable MembersCanCreatePrivatePages { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

MembersCanCreatePrivateRepositories^Required

public IResolvable MembersCanCreatePrivateRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

MembersCanCreatePublicPages^Required

public IResolvable MembersCanCreatePublicPages { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

MembersCanCreatePublicRepositories^Required

public IResolvable MembersCanCreatePublicRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

MembersCanCreateRepositories^Required

public IResolvable MembersCanCreateRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

MembersCanForkPrivateRepositories^Required

public IResolvable MembersCanForkPrivateRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

NodeId^Required

public string NodeId { get; }

• Type: string

---

Orgname^Required

public string Orgname { get; }

• Type: string

---

Plan^Required

public string Plan { get; }

• Type: string

---

Repositories^Required

public string[] Repositories { get; }

• Type: string[]

---

SecretScanningEnabledForNewRepositories^Required

public IResolvable SecretScanningEnabledForNewRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

SecretScanningPushProtectionEnabledForNewRepositories^Required

public IResolvable SecretScanningPushProtectionEnabledForNewRepositories { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

TwoFactorRequirementEnabled^Required

public IResolvable TwoFactorRequirementEnabled { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

Users^Required

public StringMapList Users { get; }

• Type: HashiCorp.Cdktf.StringMapList

---

WebCommitSignoffRequired^Required

public IResolvable WebCommitSignoffRequired { get; }

• Type: HashiCorp.Cdktf.IResolvable

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

IgnoreArchivedReposInput^Optional

public object IgnoreArchivedReposInput { get; }

• Type: object

---

NameInput^Optional

public string NameInput { get; }

• Type: string

---

SummaryOnlyInput^Optional

public object SummaryOnlyInput { get; }

• Type: object

---

Id^Required

public string Id { get; }

• Type: string

---

IgnoreArchivedRepos^Required

public object IgnoreArchivedRepos { get; }

• Type: object

---

Name^Required

public string Name { get; }

• Type: string

---

SummaryOnly^Required

public object SummaryOnly { get; }

• Type: object

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DataGithubOrganizationConfig

Initializer

using HashiCorp.Cdktf.Providers.Github;

new DataGithubOrganizationConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    string Id = null,
    object IgnoreArchivedRepos = null,
    object SummaryOnly = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
Name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#name DataGithubOrganization#name}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#id DataGithubOrganization#id}.
IgnoreArchivedRepos	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}.
SummaryOnly	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#summary_only DataGithubOrganization#summary_only}.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Name^Required

public string Name { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#name DataGithubOrganization#name}.

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#id DataGithubOrganization#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.

---

IgnoreArchivedRepos^Optional

public object IgnoreArchivedRepos { get; set; }

• Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}.

---

SummaryOnly^Optional

public object SummaryOnly { get; set; }

• Type: object

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.6.0/docs/data-sources/organization#summary_only DataGithubOrganization#summary_only}.

---