Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization github_organization}.
import io.cdktn.providers.github.data_github_organization.DataGithubOrganization;
DataGithubOrganization.Builder.create(Construct scope, java.lang.String id)
// .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
// .count(java.lang.Number|TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
.name(java.lang.String)
// .id(java.lang.String)
// .ignoreArchivedRepos(java.lang.Boolean|IResolvable)
// .summaryOnly(java.lang.Boolean|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 |
io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number|io.cdktn.cdktn.TerraformCount |
No description. |
dependsOn |
java.util.List<io.cdktn.cdktn.ITerraformDependable> |
No description. |
forEach |
io.cdktn.cdktn.ITerraformIterator |
No description. |
lifecycle |
io.cdktn.cdktn.TerraformResourceLifecycle |
No description. |
provider |
io.cdktn.cdktn.TerraformProvider |
No description. |
provisioners |
java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> |
No description. |
name |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#name DataGithubOrganization#name}. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#id DataGithubOrganization#id}. |
ignoreArchivedRepos |
java.lang.Boolean|io.cdktn.cdktn.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}. |
summaryOnly |
java.lang.Boolean|io.cdktn.cdktn.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#summary_only DataGithubOrganization#summary_only}. |
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
- Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
- Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
- Type: io.cdktn.cdktn.ITerraformIterator
- Type: io.cdktn.cdktn.TerraformResourceLifecycle
- Type: io.cdktn.cdktn.TerraformProvider
- Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#name DataGithubOrganization#name}.
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/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.
- Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}.
- Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#summary_only DataGithubOrganization#summary_only}.
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
with |
Applies one or more mixins to 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. |
public java.lang.String toString()Returns a string representation of this construct.
public IConstruct with(IMixin... mixins)Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
- Type: software.constructs.IMixin...
The mixins to apply.
public void addOverride(java.lang.String path, java.lang.Object value)- Type: java.lang.String
- Type: java.lang.Object
public void overrideLogicalId(java.lang.String newLogicalId)Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
public void resetOverrideLogicalId()Resets a previously passed logical Id to use the auto-generated logical id again.
public java.lang.Object toHclTerraform()Adds this resource to the terraform JSON output.
public java.lang.Object toMetadata()public java.lang.Object toTerraform()Adds this resource to the terraform JSON output.
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)- Type: java.lang.String
public void resetId()public void resetIgnoreArchivedRepos()public void resetSummaryOnly()| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformDataSource |
No description. |
generateConfigForImport |
Generates CDKTN code for importing a DataGithubOrganization resource upon running "cdktn plan ". |
import io.cdktn.providers.github.data_github_organization.DataGithubOrganization;
DataGithubOrganization.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.
- Type: java.lang.Object
Any object.
import io.cdktn.providers.github.data_github_organization.DataGithubOrganization;
DataGithubOrganization.isTerraformElement(java.lang.Object x)- Type: java.lang.Object
import io.cdktn.providers.github.data_github_organization.DataGithubOrganization;
DataGithubOrganization.isTerraformDataSource(java.lang.Object x)- Type: java.lang.Object
import io.cdktn.providers.github.data_github_organization.DataGithubOrganization;
DataGithubOrganization.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataGithubOrganization.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)Generates CDKTN code for importing a DataGithubOrganization resource upon running "cdktn plan ".
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The construct id used in the generated config for the DataGithubOrganization to import.
- Type: java.lang.String
The id of the existing DataGithubOrganization that should be imported.
Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#import import section} in the documentation of this resource for the id to use
- Type: io.cdktn.cdktn.TerraformProvider
? Optional instance of the provider where the DataGithubOrganization to import is found.
| Name | Type | Description |
|---|---|---|
node |
software.constructs.Node |
The tree node. |
cdktfStack |
io.cdktn.cdktn.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 |
io.cdktn.cdktn.TerraformProviderGeneratorMetadata |
No description. |
count |
java.lang.Number|io.cdktn.cdktn.TerraformCount |
No description. |
dependsOn |
java.util.List<java.lang.String> |
No description. |
forEach |
io.cdktn.cdktn.ITerraformIterator |
No description. |
lifecycle |
io.cdktn.cdktn.TerraformResourceLifecycle |
No description. |
provider |
io.cdktn.cdktn.TerraformProvider |
No description. |
advancedSecurityEnabledForNewRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
defaultRepositoryPermission |
java.lang.String |
No description. |
dependabotAlertsEnabledForNewRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
dependabotSecurityUpdatesEnabledForNewRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
dependencyGraphEnabledForNewRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
description |
java.lang.String |
No description. |
login |
java.lang.String |
No description. |
members |
java.util.List<java.lang.String> |
No description. |
membersAllowedRepositoryCreationType |
java.lang.String |
No description. |
membersCanCreateInternalRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
membersCanCreatePages |
io.cdktn.cdktn.IResolvable |
No description. |
membersCanCreatePrivatePages |
io.cdktn.cdktn.IResolvable |
No description. |
membersCanCreatePrivateRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
membersCanCreatePublicPages |
io.cdktn.cdktn.IResolvable |
No description. |
membersCanCreatePublicRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
membersCanCreateRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
membersCanForkPrivateRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
nodeId |
java.lang.String |
No description. |
orgname |
java.lang.String |
No description. |
plan |
java.lang.String |
No description. |
repositories |
java.util.List<java.lang.String> |
No description. |
secretScanningEnabledForNewRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
secretScanningPushProtectionEnabledForNewRepositories |
io.cdktn.cdktn.IResolvable |
No description. |
twoFactorRequirementEnabled |
io.cdktn.cdktn.IResolvable |
No description. |
users |
io.cdktn.cdktn.StringMapList |
No description. |
webCommitSignoffRequired |
io.cdktn.cdktn.IResolvable |
No description. |
idInput |
java.lang.String |
No description. |
ignoreArchivedReposInput |
java.lang.Boolean|io.cdktn.cdktn.IResolvable |
No description. |
nameInput |
java.lang.String |
No description. |
summaryOnlyInput |
java.lang.Boolean|io.cdktn.cdktn.IResolvable |
No description. |
id |
java.lang.String |
No description. |
ignoreArchivedRepos |
java.lang.Boolean|io.cdktn.cdktn.IResolvable |
No description. |
name |
java.lang.String |
No description. |
summaryOnly |
java.lang.Boolean|io.cdktn.cdktn.IResolvable |
No description. |
public Node getNode();- Type: software.constructs.Node
The tree node.
public TerraformStack getCdktfStack();- Type: io.cdktn.cdktn.TerraformStack
public java.lang.String getFqn();- Type: java.lang.String
public java.lang.String getFriendlyUniqueId();- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();- Type: java.util.Map<java.lang.String, java.lang.Object>
public java.lang.String getTerraformResourceType();- Type: java.lang.String
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();- Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata
public java.lang.Number|TerraformCount getCount();- Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
public java.util.List<java.lang.String> getDependsOn();- Type: java.util.List<java.lang.String>
public ITerraformIterator getForEach();- Type: io.cdktn.cdktn.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();- Type: io.cdktn.cdktn.TerraformResourceLifecycle
public TerraformProvider getProvider();- Type: io.cdktn.cdktn.TerraformProvider
public IResolvable getAdvancedSecurityEnabledForNewRepositories();- Type: io.cdktn.cdktn.IResolvable
public java.lang.String getDefaultRepositoryPermission();- Type: java.lang.String
public IResolvable getDependabotAlertsEnabledForNewRepositories();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getDependabotSecurityUpdatesEnabledForNewRepositories();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getDependencyGraphEnabledForNewRepositories();- Type: io.cdktn.cdktn.IResolvable
public java.lang.String getDescription();- Type: java.lang.String
public java.lang.String getLogin();- Type: java.lang.String
public java.util.List<java.lang.String> getMembers();- Type: java.util.List<java.lang.String>
public java.lang.String getMembersAllowedRepositoryCreationType();- Type: java.lang.String
public IResolvable getMembersCanCreateInternalRepositories();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getMembersCanCreatePages();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getMembersCanCreatePrivatePages();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getMembersCanCreatePrivateRepositories();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getMembersCanCreatePublicPages();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getMembersCanCreatePublicRepositories();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getMembersCanCreateRepositories();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getMembersCanForkPrivateRepositories();- Type: io.cdktn.cdktn.IResolvable
public java.lang.String getNodeId();- Type: java.lang.String
public java.lang.String getOrgname();- Type: java.lang.String
public java.lang.String getPlan();- Type: java.lang.String
public java.util.List<java.lang.String> getRepositories();- Type: java.util.List<java.lang.String>
public IResolvable getSecretScanningEnabledForNewRepositories();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getSecretScanningPushProtectionEnabledForNewRepositories();- Type: io.cdktn.cdktn.IResolvable
public IResolvable getTwoFactorRequirementEnabled();- Type: io.cdktn.cdktn.IResolvable
public StringMapList getUsers();- Type: io.cdktn.cdktn.StringMapList
public IResolvable getWebCommitSignoffRequired();- Type: io.cdktn.cdktn.IResolvable
public java.lang.String getIdInput();- Type: java.lang.String
public java.lang.Boolean|IResolvable getIgnoreArchivedReposInput();- Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
public java.lang.String getNameInput();- Type: java.lang.String
public java.lang.Boolean|IResolvable getSummaryOnlyInput();- Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
public java.lang.String getId();- Type: java.lang.String
public java.lang.Boolean|IResolvable getIgnoreArchivedRepos();- Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
public java.lang.String getName();- Type: java.lang.String
public java.lang.Boolean|IResolvable getSummaryOnly();- Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
| Name | Type | Description |
|---|---|---|
tfResourceType |
java.lang.String |
No description. |
public java.lang.String getTfResourceType();- Type: java.lang.String
import io.cdktn.providers.github.data_github_organization.DataGithubOrganizationConfig;
DataGithubOrganizationConfig.builder()
// .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
// .count(java.lang.Number|TerraformCount)
// .dependsOn(java.util.List<ITerraformDependable>)
// .forEach(ITerraformIterator)
// .lifecycle(TerraformResourceLifecycle)
// .provider(TerraformProvider)
// .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
.name(java.lang.String)
// .id(java.lang.String)
// .ignoreArchivedRepos(java.lang.Boolean|IResolvable)
// .summaryOnly(java.lang.Boolean|IResolvable)
.build();| Name | Type | Description |
|---|---|---|
connection |
io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection |
No description. |
count |
java.lang.Number|io.cdktn.cdktn.TerraformCount |
No description. |
dependsOn |
java.util.List<io.cdktn.cdktn.ITerraformDependable> |
No description. |
forEach |
io.cdktn.cdktn.ITerraformIterator |
No description. |
lifecycle |
io.cdktn.cdktn.TerraformResourceLifecycle |
No description. |
provider |
io.cdktn.cdktn.TerraformProvider |
No description. |
provisioners |
java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner> |
No description. |
name |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#name DataGithubOrganization#name}. |
id |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#id DataGithubOrganization#id}. |
ignoreArchivedRepos |
java.lang.Boolean|io.cdktn.cdktn.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}. |
summaryOnly |
java.lang.Boolean|io.cdktn.cdktn.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#summary_only DataGithubOrganization#summary_only}. |
public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();- Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection
public java.lang.Number|TerraformCount getCount();- Type: java.lang.Number|io.cdktn.cdktn.TerraformCount
public java.util.List<ITerraformDependable> getDependsOn();- Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>
public ITerraformIterator getForEach();- Type: io.cdktn.cdktn.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();- Type: io.cdktn.cdktn.TerraformResourceLifecycle
public TerraformProvider getProvider();- Type: io.cdktn.cdktn.TerraformProvider
public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();- Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>
public java.lang.String getName();- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#name DataGithubOrganization#name}.
public java.lang.String getId();- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/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.
public java.lang.Boolean|IResolvable getIgnoreArchivedRepos();- Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}.
public java.lang.Boolean|IResolvable getSummaryOnly();- Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/organization#summary_only DataGithubOrganization#summary_only}.