`dataGithubRepositories` Submodule

Constructs

DataGithubRepositories

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

Initializers

using HashiCorp.Cdktf.Providers.Github;

new DataGithubRepositories(Construct Scope, string Id, DataGithubRepositoriesConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	The scope in which to define this construct.
`Id`	`string`	The scoped construct ID.
`Config`	`DataGithubRepositoriesConfig`	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: DataGithubRepositoriesConfig

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.
`ResetIncludeRepoId`	No description.
`ResetResultsPerPage`	No description.
`ResetSort`	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()

`ResetIncludeRepoId`

private void ResetIncludeRepoId()

`ResetResultsPerPage`

private void ResetResultsPerPage()

`ResetSort`

private void ResetSort()

Static Functions

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

`IsConstruct`

using HashiCorp.Cdktf.Providers.Github;

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

DataGithubRepositories.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformDataSource`

using HashiCorp.Cdktf.Providers.Github;

DataGithubRepositories.IsTerraformDataSource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using HashiCorp.Cdktf.Providers.Github;

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

Generates CDKTF code for importing a DataGithubRepositories 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 DataGithubRepositories to import.

`ImportFromId`^Required

Type: string

The id of the existing DataGithubRepositories that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.9.0/docs/data-sources/repositories#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 DataGithubRepositories 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`	`double\|HashiCorp.Cdktf.TerraformCount`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`HashiCorp.Cdktf.ITerraformIterator`	No description.
`Lifecycle`	`HashiCorp.Cdktf.TerraformResourceLifecycle`	No description.
`Provider`	`HashiCorp.Cdktf.TerraformProvider`	No description.
`FullNames`	`string[]`	No description.
`Names`	`string[]`	No description.
`RepoIds`	`double[]`	No description.
`IdInput`	`string`	No description.
`IncludeRepoIdInput`	`bool\|HashiCorp.Cdktf.IResolvable`	No description.
`QueryInput`	`string`	No description.
`ResultsPerPageInput`	`double`	No description.
`SortInput`	`string`	No description.
`Id`	`string`	No description.
`IncludeRepoId`	`bool\|HashiCorp.Cdktf.IResolvable`	No description.
`Query`	`string`	No description.
`ResultsPerPage`	`double`	No description.
`Sort`	`string`	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 double|TerraformCount Count { get; }

Type: double|HashiCorp.Cdktf.TerraformCount

`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

`FullNames`^Required

public string[] FullNames { get; }

Type: string[]

`Names`^Required

public string[] Names { get; }

Type: string[]

`RepoIds`^Required

public double[] RepoIds { get; }

Type: double[]

`IdInput`^Optional

public string IdInput { get; }

Type: string

`IncludeRepoIdInput`^Optional

public bool|IResolvable IncludeRepoIdInput { get; }

Type: bool|HashiCorp.Cdktf.IResolvable

`QueryInput`^Optional

public string QueryInput { get; }

Type: string

`ResultsPerPageInput`^Optional

public double ResultsPerPageInput { get; }

Type: double

`SortInput`^Optional

public string SortInput { get; }

Type: string

`Id`^Required

public string Id { get; }

Type: string

`IncludeRepoId`^Required

public bool|IResolvable IncludeRepoId { get; }

Type: bool|HashiCorp.Cdktf.IResolvable

`Query`^Required

public string Query { get; }

Type: string

`ResultsPerPage`^Required

public double ResultsPerPage { get; }

Type: double

`Sort`^Required

public string Sort { get; }

Type: string

Constants

Name	Type	Description
`TfResourceType`	`string`	No description.

`TfResourceType`^Required

public string TfResourceType { get; }

Type: string

Structs

DataGithubRepositoriesConfig

Initializer

using HashiCorp.Cdktf.Providers.Github;

new DataGithubRepositoriesConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string Query,
    string Id = null,
    bool|IResolvable IncludeRepoId = null,
    double ResultsPerPage = null,
    string Sort = null
};

Properties

Name	Type	Description
`Connection`	`HashiCorp.Cdktf.SSHProvisionerConnection\|HashiCorp.Cdktf.WinrmProvisionerConnection`	No description.
`Count`	`double\|HashiCorp.Cdktf.TerraformCount`	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`	`HashiCorp.Cdktf.FileProvisioner\|HashiCorp.Cdktf.LocalExecProvisioner\|HashiCorp.Cdktf.RemoteExecProvisioner[]`	No description.
`Query`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.9.0/docs/data-sources/repositories#query DataGithubRepositories#query}.
`Id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.9.0/docs/data-sources/repositories#id DataGithubRepositories#id}.
`IncludeRepoId`	`bool\|HashiCorp.Cdktf.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.9.0/docs/data-sources/repositories#include_repo_id DataGithubRepositories#include_repo_id}.
`ResultsPerPage`	`double`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.9.0/docs/data-sources/repositories#results_per_page DataGithubRepositories#results_per_page}.
`Sort`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.9.0/docs/data-sources/repositories#sort DataGithubRepositories#sort}.

`Connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }

Type: HashiCorp.Cdktf.SSHProvisionerConnection|HashiCorp.Cdktf.WinrmProvisionerConnection

`Count`^Optional

public double|TerraformCount Count { get; set; }

Type: double|HashiCorp.Cdktf.TerraformCount

`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 (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }

Type: HashiCorp.Cdktf.FileProvisioner|HashiCorp.Cdktf.LocalExecProvisioner|HashiCorp.Cdktf.RemoteExecProvisioner[]

`Query`^Required

public string Query { get; set; }

Type: string

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

`Id`^Optional

public string Id { get; set; }

Type: string

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

public bool|IResolvable IncludeRepoId { get; set; }

Type: bool|HashiCorp.Cdktf.IResolvable

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

`ResultsPerPage`^Optional

public double ResultsPerPage { get; set; }

Type: double

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

`Sort`^Optional

public string Sort { get; set; }

Type: string

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

FilesExpand file tree

dataGithubRepositories.csharp.md

Latest commit

History

dataGithubRepositories.csharp.md

File metadata and controls

dataGithubRepositories Submodule

Constructs