Skip to content

Latest commit

 

History

History
1148 lines (723 loc) · 54.6 KB

dataGithubOrganization.java.md

File metadata and controls

1148 lines (723 loc) · 54.6 KB

dataGithubOrganization Submodule

Constructs

DataGithubOrganization

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

Initializers

import com.hashicorp.cdktf.providers.github.data_github_organization.DataGithubOrganization;

DataGithubOrganization.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>)
    .name(java.lang.String)
//  .id(java.lang.String)
//  .ignoreArchivedRepos(java.lang.Boolean)
//  .ignoreArchivedRepos(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.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/data-sources/organization#name DataGithubOrganization#name}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/data-sources/organization#id DataGithubOrganization#id}.
ignoreArchivedRepos java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}.

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>

nameRequired
  • Type: java.lang.String

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


idOptional
  • Type: java.lang.String

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


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

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


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.

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()

Adds this resource to the terraform JSON output.

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

Adds this resource to the terraform JSON output.

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

interpolationForAttribute
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String

resetId
public void resetId()
resetIgnoreArchivedRepos
public void resetIgnoreArchivedRepos()

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
import com.hashicorp.cdktf.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.

xRequired
  • Type: java.lang.Object

Any object.


isTerraformElement
import com.hashicorp.cdktf.providers.github.data_github_organization.DataGithubOrganization;

DataGithubOrganization.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object

isTerraformDataSource
import com.hashicorp.cdktf.providers.github.data_github_organization.DataGithubOrganization;

DataGithubOrganization.isTerraformDataSource(java.lang.Object x)
xRequired
  • Type: java.lang.Object

generateConfigForImport
import com.hashicorp.cdktf.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 CDKTF code for importing a DataGithubOrganization 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 DataGithubOrganization to import.


importFromIdRequired
  • 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.2.3/docs/data-sources/organization#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 DataGithubOrganization 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.
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.
advancedSecurityEnabledForNewRepositories com.hashicorp.cdktf.IResolvable No description.
defaultRepositoryPermission java.lang.String No description.
dependabotAlertsEnabledForNewRepositories com.hashicorp.cdktf.IResolvable No description.
dependabotSecurityUpdatesEnabledForNewRepositories com.hashicorp.cdktf.IResolvable No description.
dependencyGraphEnabledForNewRepositories com.hashicorp.cdktf.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 com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePages com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePrivatePages com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePrivateRepositories com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePublicPages com.hashicorp.cdktf.IResolvable No description.
membersCanCreatePublicRepositories com.hashicorp.cdktf.IResolvable No description.
membersCanCreateRepositories com.hashicorp.cdktf.IResolvable No description.
membersCanForkPrivateRepositories com.hashicorp.cdktf.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 com.hashicorp.cdktf.IResolvable No description.
secretScanningPushProtectionEnabledForNewRepositories com.hashicorp.cdktf.IResolvable No description.
twoFactorRequirementEnabled com.hashicorp.cdktf.IResolvable No description.
users com.hashicorp.cdktf.StringMapList No description.
webCommitSignoffRequired com.hashicorp.cdktf.IResolvable No description.
idInput java.lang.String No description.
ignoreArchivedReposInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nameInput java.lang.String No description.
id java.lang.String No description.
ignoreArchivedRepos java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
name java.lang.String 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

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

advancedSecurityEnabledForNewRepositoriesRequired
public IResolvable getAdvancedSecurityEnabledForNewRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

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

dependabotAlertsEnabledForNewRepositoriesRequired
public IResolvable getDependabotAlertsEnabledForNewRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

dependabotSecurityUpdatesEnabledForNewRepositoriesRequired
public IResolvable getDependabotSecurityUpdatesEnabledForNewRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

dependencyGraphEnabledForNewRepositoriesRequired
public IResolvable getDependencyGraphEnabledForNewRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

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

loginRequired
public java.lang.String getLogin();
  • Type: java.lang.String

membersRequired
public java.util.List<java.lang.String> getMembers();
  • Type: java.util.List<java.lang.String>

membersAllowedRepositoryCreationTypeRequired
public java.lang.String getMembersAllowedRepositoryCreationType();
  • Type: java.lang.String

membersCanCreateInternalRepositoriesRequired
public IResolvable getMembersCanCreateInternalRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

membersCanCreatePagesRequired
public IResolvable getMembersCanCreatePages();
  • Type: com.hashicorp.cdktf.IResolvable

membersCanCreatePrivatePagesRequired
public IResolvable getMembersCanCreatePrivatePages();
  • Type: com.hashicorp.cdktf.IResolvable

membersCanCreatePrivateRepositoriesRequired
public IResolvable getMembersCanCreatePrivateRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

membersCanCreatePublicPagesRequired
public IResolvable getMembersCanCreatePublicPages();
  • Type: com.hashicorp.cdktf.IResolvable

membersCanCreatePublicRepositoriesRequired
public IResolvable getMembersCanCreatePublicRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

membersCanCreateRepositoriesRequired
public IResolvable getMembersCanCreateRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

membersCanForkPrivateRepositoriesRequired
public IResolvable getMembersCanForkPrivateRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

nodeIdRequired
public java.lang.String getNodeId();
  • Type: java.lang.String

orgnameRequired
public java.lang.String getOrgname();
  • Type: java.lang.String

planRequired
public java.lang.String getPlan();
  • Type: java.lang.String

repositoriesRequired
public java.util.List<java.lang.String> getRepositories();
  • Type: java.util.List<java.lang.String>

secretScanningEnabledForNewRepositoriesRequired
public IResolvable getSecretScanningEnabledForNewRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

secretScanningPushProtectionEnabledForNewRepositoriesRequired
public IResolvable getSecretScanningPushProtectionEnabledForNewRepositories();
  • Type: com.hashicorp.cdktf.IResolvable

twoFactorRequirementEnabledRequired
public IResolvable getTwoFactorRequirementEnabled();
  • Type: com.hashicorp.cdktf.IResolvable

usersRequired
public StringMapList getUsers();
  • Type: com.hashicorp.cdktf.StringMapList

webCommitSignoffRequiredRequired
public IResolvable getWebCommitSignoffRequired();
  • Type: com.hashicorp.cdktf.IResolvable

idInputOptional
public java.lang.String getIdInput();
  • Type: java.lang.String

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

nameInputOptional
public java.lang.String getNameInput();
  • Type: java.lang.String

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

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

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

Constants

Name Type Description
tfResourceType java.lang.String No description.

tfResourceTypeRequired
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

DataGithubOrganizationConfig

Initializer

import com.hashicorp.cdktf.providers.github.data_github_organization.DataGithubOrganizationConfig;

DataGithubOrganizationConfig.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>)
    .name(java.lang.String)
//  .id(java.lang.String)
//  .ignoreArchivedRepos(java.lang.Boolean)
//  .ignoreArchivedRepos(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.
name java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/data-sources/organization#name DataGithubOrganization#name}.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/data-sources/organization#id DataGithubOrganization#id}.
ignoreArchivedRepos java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}.

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>

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

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


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

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


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

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