`dataGithubOrganization` Submodule

Constructs

DataGithubOrganization

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

Initializers

from cdktf_cdktf_provider_github import data_github_organization

dataGithubOrganization.DataGithubOrganization(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  id: str = None,
  ignore_archived_repos: typing.Union[bool, IResolvable] = None,
  summary_only: typing.Union[bool, IResolvable] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/data-sources/organization#name DataGithubOrganization#name}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/data-sources/organization#id DataGithubOrganization#id}.
`ignore_archived_repos`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}.
`summary_only`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/data-sources/organization#summary_only DataGithubOrganization#summary_only}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`name`^Required

Type: str

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

`id`^Optional

Type: str

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

`ignore_archived_repos`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

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

`summary_only`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	Adds this resource to the terraform JSON output.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`reset_id`	No description.
`reset_ignore_archived_repos`	No description.
`reset_summary_only`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`reset_id`

def reset_id() -> None

`reset_ignore_archived_repos`

def reset_ignore_archived_repos() -> None

`reset_summary_only`

def reset_summary_only() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_data_source`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a DataGithubOrganization resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_github import data_github_organization

dataGithubOrganization.DataGithubOrganization.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_github import data_github_organization

dataGithubOrganization.DataGithubOrganization.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_data_source`

from cdktf_cdktf_provider_github import data_github_organization

dataGithubOrganization.DataGithubOrganization.is_terraform_data_source(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_github import data_github_organization

dataGithubOrganization.DataGithubOrganization.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing DataGithubOrganization that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`advanced_security_enabled_for_new_repositories`	`cdktf.IResolvable`	No description.
`default_repository_permission`	`str`	No description.
`dependabot_alerts_enabled_for_new_repositories`	`cdktf.IResolvable`	No description.
`dependabot_security_updates_enabled_for_new_repositories`	`cdktf.IResolvable`	No description.
`dependency_graph_enabled_for_new_repositories`	`cdktf.IResolvable`	No description.
`description`	`str`	No description.
`login`	`str`	No description.
`members`	`typing.List[str]`	No description.
`members_allowed_repository_creation_type`	`str`	No description.
`members_can_create_internal_repositories`	`cdktf.IResolvable`	No description.
`members_can_create_pages`	`cdktf.IResolvable`	No description.
`members_can_create_private_pages`	`cdktf.IResolvable`	No description.
`members_can_create_private_repositories`	`cdktf.IResolvable`	No description.
`members_can_create_public_pages`	`cdktf.IResolvable`	No description.
`members_can_create_public_repositories`	`cdktf.IResolvable`	No description.
`members_can_create_repositories`	`cdktf.IResolvable`	No description.
`members_can_fork_private_repositories`	`cdktf.IResolvable`	No description.
`node_id`	`str`	No description.
`orgname`	`str`	No description.
`plan`	`str`	No description.
`repositories`	`typing.List[str]`	No description.
`secret_scanning_enabled_for_new_repositories`	`cdktf.IResolvable`	No description.
`secret_scanning_push_protection_enabled_for_new_repositories`	`cdktf.IResolvable`	No description.
`two_factor_requirement_enabled`	`cdktf.IResolvable`	No description.
`users`	`cdktf.StringMapList`	No description.
`web_commit_signoff_required`	`cdktf.IResolvable`	No description.
`id_input`	`str`	No description.
`ignore_archived_repos_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`name_input`	`str`	No description.
`summary_only_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id`	`str`	No description.
`ignore_archived_repos`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`name`	`str`	No description.
`summary_only`	`typing.Union[bool, cdktf.IResolvable]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`advanced_security_enabled_for_new_repositories`^Required

advanced_security_enabled_for_new_repositories: IResolvable

Type: cdktf.IResolvable

`default_repository_permission`^Required

default_repository_permission: str

Type: str

`dependabot_alerts_enabled_for_new_repositories`^Required

dependabot_alerts_enabled_for_new_repositories: IResolvable

Type: cdktf.IResolvable

`dependabot_security_updates_enabled_for_new_repositories`^Required

dependabot_security_updates_enabled_for_new_repositories: IResolvable

Type: cdktf.IResolvable

`dependency_graph_enabled_for_new_repositories`^Required

dependency_graph_enabled_for_new_repositories: IResolvable

Type: cdktf.IResolvable

`description`^Required

description: str

Type: str

`login`^Required

login: str

Type: str

`members`^Required

members: typing.List[str]

Type: typing.List[str]

`members_allowed_repository_creation_type`^Required

members_allowed_repository_creation_type: str

Type: str

`members_can_create_internal_repositories`^Required

members_can_create_internal_repositories: IResolvable

Type: cdktf.IResolvable

`members_can_create_pages`^Required

members_can_create_pages: IResolvable

Type: cdktf.IResolvable

`members_can_create_private_pages`^Required

members_can_create_private_pages: IResolvable

Type: cdktf.IResolvable

`members_can_create_private_repositories`^Required

members_can_create_private_repositories: IResolvable

Type: cdktf.IResolvable

`members_can_create_public_pages`^Required

members_can_create_public_pages: IResolvable

Type: cdktf.IResolvable

`members_can_create_public_repositories`^Required

members_can_create_public_repositories: IResolvable

Type: cdktf.IResolvable

`members_can_create_repositories`^Required

members_can_create_repositories: IResolvable

Type: cdktf.IResolvable

`members_can_fork_private_repositories`^Required

members_can_fork_private_repositories: IResolvable

Type: cdktf.IResolvable

`node_id`^Required

node_id: str

Type: str

`orgname`^Required

orgname: str

Type: str

`plan`^Required

plan: str

Type: str

`repositories`^Required

repositories: typing.List[str]

Type: typing.List[str]

`secret_scanning_enabled_for_new_repositories`^Required

secret_scanning_enabled_for_new_repositories: IResolvable

Type: cdktf.IResolvable

`secret_scanning_push_protection_enabled_for_new_repositories`^Required

secret_scanning_push_protection_enabled_for_new_repositories: IResolvable

Type: cdktf.IResolvable

`two_factor_requirement_enabled`^Required

two_factor_requirement_enabled: IResolvable

Type: cdktf.IResolvable

`users`^Required

users: StringMapList

Type: cdktf.StringMapList

`web_commit_signoff_required`^Required

web_commit_signoff_required: IResolvable

Type: cdktf.IResolvable

`id_input`^Optional

id_input: str

Type: str

`ignore_archived_repos_input`^Optional

ignore_archived_repos_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`name_input`^Optional

name_input: str

Type: str

`summary_only_input`^Optional

summary_only_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id`^Required

id: str

Type: str

`ignore_archived_repos`^Required

ignore_archived_repos: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`name`^Required

name: str

Type: str

`summary_only`^Required

summary_only: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

DataGithubOrganizationConfig

Initializer

from cdktf_cdktf_provider_github import data_github_organization

dataGithubOrganization.DataGithubOrganizationConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  id: str = None,
  ignore_archived_repos: typing.Union[bool, IResolvable] = None,
  summary_only: typing.Union[bool, IResolvable] = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/data-sources/organization#name DataGithubOrganization#name}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/data-sources/organization#id DataGithubOrganization#id}.
`ignore_archived_repos`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/data-sources/organization#ignore_archived_repos DataGithubOrganization#ignore_archived_repos}.
`summary_only`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.4.0/docs/data-sources/organization#summary_only DataGithubOrganization#summary_only}.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`name`^Required

name: str

Type: str

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

`id`^Optional

id: str

Type: str

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

`ignore_archived_repos`^Optional

ignore_archived_repos: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

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

`summary_only`^Optional

summary_only: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

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

Files

dataGithubOrganization.python.md

Latest commit

History

dataGithubOrganization.python.md

File metadata and controls

dataGithubOrganization Submodule

Constructs