`dataGithubRepositories` Submodule

Constructs

DataGithubRepositories

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories github_repositories}.

Initializers

import io.cdktn.providers.github.data_github_repositories.DataGithubRepositories;

DataGithubRepositories.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>)
    .query(java.lang.String)
//  .id(java.lang.String)
//  .includeRepoId(java.lang.Boolean|IResolvable)
//  .resultsPerPage(java.lang.Number)
//  .sort(java.lang.String)
    .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.
`query`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#query DataGithubRepositories#query}.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#id DataGithubRepositories#id}.
`includeRepoId`	`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/repositories#include_repo_id DataGithubRepositories#include_repo_id}.
`resultsPerPage`	`java.lang.Number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#results_per_page DataGithubRepositories#results_per_page}.
`sort`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#sort DataGithubRepositories#sort}.

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection

`count`^Optional

Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

`dependsOn`^Optional

Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>

`forEach`^Optional

Type: io.cdktn.cdktn.ITerraformIterator

`lifecycle`^Optional

Type: io.cdktn.cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: io.cdktn.cdktn.TerraformProvider

`provisioners`^Optional

Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>

`query`^Required

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#query DataGithubRepositories#query}.

`id`^Optional

Type: java.lang.String

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

`includeRepoId`^Optional

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/repositories#include_repo_id DataGithubRepositories#include_repo_id}.

`resultsPerPage`^Optional

Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#results_per_page DataGithubRepositories#results_per_page}.

`sort`^Optional

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#sort DataGithubRepositories#sort}.

Methods

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.
`resetIncludeRepoId`	No description.
`resetResultsPerPage`	No description.
`resetSort`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`with`

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.

`mixins`^Required

Type: software.constructs.IMixin...

The mixins to apply.

`addOverride`

public void addOverride(java.lang.String path, java.lang.Object value)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

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

`newLogicalId`^Required

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)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`resetId`

public void resetId()

`resetIncludeRepoId`

public void resetIncludeRepoId()

`resetResultsPerPage`

public void resetResultsPerPage()

`resetSort`

public void resetSort()

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformDataSource`	No description.
`generateConfigForImport`	Generates CDKTN code for importing a DataGithubRepositories resource upon running "cdktn plan ".

`isConstruct`

import io.cdktn.providers.github.data_github_repositories.DataGithubRepositories;

DataGithubRepositories.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.

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import io.cdktn.providers.github.data_github_repositories.DataGithubRepositories;

DataGithubRepositories.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformDataSource`

import io.cdktn.providers.github.data_github_repositories.DataGithubRepositories;

DataGithubRepositories.isTerraformDataSource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import io.cdktn.providers.github.data_github_repositories.DataGithubRepositories;

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

Generates CDKTN code for importing a DataGithubRepositories resource upon running "cdktn plan ".

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: java.lang.String

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

`importFromId`^Required

Type: java.lang.String

The id of the existing DataGithubRepositories that should be imported.

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

`provider`^Optional

Type: io.cdktn.cdktn.TerraformProvider

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

Properties

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.
`fullNames`	`java.util.List<java.lang.String>`	No description.
`names`	`java.util.List<java.lang.String>`	No description.
`repoIds`	`java.util.List<java.lang.Number>`	No description.
`idInput`	`java.lang.String`	No description.
`includeRepoIdInput`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	No description.
`queryInput`	`java.lang.String`	No description.
`resultsPerPageInput`	`java.lang.Number`	No description.
`sortInput`	`java.lang.String`	No description.
`id`	`java.lang.String`	No description.
`includeRepoId`	`java.lang.Boolean\|io.cdktn.cdktn.IResolvable`	No description.
`query`	`java.lang.String`	No description.
`resultsPerPage`	`java.lang.Number`	No description.
`sort`	`java.lang.String`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: io.cdktn.cdktn.TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

`terraformMetaArguments`^Required

public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();

Type: java.util.Map<java.lang.String, java.lang.Object>

`terraformResourceType`^Required

public java.lang.String getTerraformResourceType();

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();

Type: io.cdktn.cdktn.TerraformProviderGeneratorMetadata

`count`^Optional

public java.lang.Number|TerraformCount getCount();

Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

`dependsOn`^Optional

public java.util.List<java.lang.String> getDependsOn();

Type: java.util.List<java.lang.String>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: io.cdktn.cdktn.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: io.cdktn.cdktn.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: io.cdktn.cdktn.TerraformProvider

`fullNames`^Required

public java.util.List<java.lang.String> getFullNames();

Type: java.util.List<java.lang.String>

`names`^Required

public java.util.List<java.lang.String> getNames();

Type: java.util.List<java.lang.String>

`repoIds`^Required

public java.util.List<java.lang.Number> getRepoIds();

Type: java.util.List<java.lang.Number>

`idInput`^Optional

public java.lang.String getIdInput();

Type: java.lang.String

`includeRepoIdInput`^Optional

public java.lang.Boolean|IResolvable getIncludeRepoIdInput();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

`queryInput`^Optional

public java.lang.String getQueryInput();

Type: java.lang.String

`resultsPerPageInput`^Optional

public java.lang.Number getResultsPerPageInput();

Type: java.lang.Number

`sortInput`^Optional

public java.lang.String getSortInput();

Type: java.lang.String

`id`^Required

public java.lang.String getId();

Type: java.lang.String

`includeRepoId`^Required

public java.lang.Boolean|IResolvable getIncludeRepoId();

Type: java.lang.Boolean|io.cdktn.cdktn.IResolvable

`query`^Required

public java.lang.String getQuery();

Type: java.lang.String

`resultsPerPage`^Required

public java.lang.Number getResultsPerPage();

Type: java.lang.Number

`sort`^Required

public java.lang.String getSort();

Type: java.lang.String

Constants

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

`tfResourceType`^Required

public java.lang.String getTfResourceType();

Type: java.lang.String

Structs

DataGithubRepositoriesConfig

Initializer

import io.cdktn.providers.github.data_github_repositories.DataGithubRepositoriesConfig;

DataGithubRepositoriesConfig.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>)
    .query(java.lang.String)
//  .id(java.lang.String)
//  .includeRepoId(java.lang.Boolean|IResolvable)
//  .resultsPerPage(java.lang.Number)
//  .sort(java.lang.String)
    .build();

Properties

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.
`query`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#query DataGithubRepositories#query}.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#id DataGithubRepositories#id}.
`includeRepoId`	`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/repositories#include_repo_id DataGithubRepositories#include_repo_id}.
`resultsPerPage`	`java.lang.Number`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#results_per_page DataGithubRepositories#results_per_page}.
`sort`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#sort DataGithubRepositories#sort}.

`connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();

Type: io.cdktn.cdktn.SSHProvisionerConnection|io.cdktn.cdktn.WinrmProvisionerConnection

`count`^Optional

public java.lang.Number|TerraformCount getCount();

Type: java.lang.Number|io.cdktn.cdktn.TerraformCount

`dependsOn`^Optional

public java.util.List<ITerraformDependable> getDependsOn();

Type: java.util.List<io.cdktn.cdktn.ITerraformDependable>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: io.cdktn.cdktn.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: io.cdktn.cdktn.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: io.cdktn.cdktn.TerraformProvider

`provisioners`^Optional

public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();

Type: java.util.List<io.cdktn.cdktn.FileProvisioner|io.cdktn.cdktn.LocalExecProvisioner|io.cdktn.cdktn.RemoteExecProvisioner>

`query`^Required

public java.lang.String getQuery();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#query DataGithubRepositories#query}.

`id`^Optional

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/repositories#id DataGithubRepositories#id}.

`includeRepoId`^Optional

public java.lang.Boolean|IResolvable getIncludeRepoId();

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/repositories#include_repo_id DataGithubRepositories#include_repo_id}.

`resultsPerPage`^Optional

public java.lang.Number getResultsPerPage();

Type: java.lang.Number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#results_per_page DataGithubRepositories#results_per_page}.

`sort`^Optional

public java.lang.String getSort();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.12.1/docs/data-sources/repositories#sort DataGithubRepositories#sort}.

FilesExpand file tree

dataGithubRepositories.java.md

Latest commit

History

dataGithubRepositories.java.md

File metadata and controls

dataGithubRepositories Submodule

Constructs